AWSSDK
Removes the permission with the specified statement id from the queue.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the Label property
The identfication of the permission you want to remove. This is the label you added in AddPermission.
this instance
Checks if Label property is set
true if Label property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the Label property.
The identfication of the permission you want to remove. This is the label you added in AddPermission.
Encapsulates the metadata and result of the Subscribe action.
Checks if SubscribeResult property is set
true if SubscribeResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SubscribeResult property.
Encapsulates the result of the Subscribe action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
Encapsulates the metadata and result of the ConfirmSubscription action.
Checks if ConfirmSubscriptionResult property is set
true if ConfirmSubscriptionResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ConfirmSubscriptionResult property.
Encapsulates the result of the ConfirmSubscription action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Sets the TopicArn property
The ARN of the topic whose access control policy you wish to modify.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the Label property
A unique identifier for the new policy statement.
this instance
Checks if Label property is set
true if Label property is set
Sets the AWSAccountIds property
The AWS account IDs of the users (principals) who will be given access to the specified
actions. The users must have AWS accounts, but do not need to be signed up
for this service.
this instance
Checks if AWSAccountIds property is set
true if AWSAccountIds property is set
Sets the ActionNames property
The action you want to allow for the specified principal(s).
this instance
Checks if ActionNames property is set
true if ActionNames property is set
Gets and sets the TopicArn property.
The ARN of the topic whose access control policy you wish to modify.
Gets and sets the Label property.
A unique identifier for the new policy statement.
Gets and sets the AWSAccountIds property.
The AWS account IDs of the users (principals) who will be given access to the specified
actions. The users must have AWS accounts, but do not need to be signed up
for this service.
Gets and sets the ActionNames property.
The action you want to allow for the specified principal(s).
ListVerifiedEmailAddressesResult Unmarshaller
Interface for unmarshallers which unmarshall objects from response data.
The Unmarshallers are stateless, and only encode the rules for what data
in the XML stream goes into what members of an object.
The type of object the unmarshaller returns
The type of the XML unmashaller context, which contains the
state during parsing of the XML stream. Usually an instance of
Amazon.Runtime.Internal.Transform.UnmarshallerContext.
Given the current position in the XML stream, extract a T.
The XML parsing context
An object of type T populated with data from the XML stream.
Response Unmarshaller for ListVerifiedEmailAddresses operation
Interface for unmarshallers which unmarshall service responses.
The Unmarshallers are stateless, and only encode the rules for what data
in the XML stream goes into what members of an object.
The type of object the unmarshaller returns
The type of the XML unmashaller context, which contains the
state of parsing the XML stream. Uaually an instance of
Amazon.Runtime.Internal.Transform.UnmarshallerContext.
Given the current position in the XML stream, extract a T.
The XML parsing context
An object of type T populated with data from the XML stream.
Extracts an exeption with data from an ErrorResponse.
The XML parsing context.
An inner exception to be included with the returned exception
The HttpStatusCode from the ErrorResponse
Either an exception based on the ErrorCode from the ErrorResponse, or the
general service exception for the service in question.
GetSendStatisticsResult Unmarshaller
Amazon SimpleDB is a web service for running queries on structured
data in real time. This service works in close conjunction with Amazon
Simple Storage Service (Amazon S3) and Amazon Elastic Compute Cloud
(Amazon EC2), collectively providing the ability to store, process
and query data sets in the cloud. These services are designed to make
web-scale computing easier and more cost-effective for developers.
Traditionally, this type of functionality has been accomplished with
a clustered relational database that requires a sizable upfront
investment, brings more complexity than is typically needed, and often
requires a DBA to maintain and administer. In contrast, Amazon SimpleDB
is easy to use and provides the core functionality of a database -
real-time lookup and simple querying of structured data without the
operational complexity. Amazon SimpleDB requires no schema, automatically
indexes your data and provides a simple API for storage and access.
This eliminates the administrative burden of data modeling, index
maintenance, and performance tuning. Developers gain access to this
functionality within Amazon's proven computing environment, are able
to scale instantly, and pay only for what they use.
Initiates the asynchronous execution of the CreateDomain operation.
The CreateDomainRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCreateDomain.
Finishes the asynchronous execution of the CreateDomain operation.
The IAsyncResult returned by the call to BeginCreateDomain.
Returns a CreateDomainResponse from S3.
Create Domain
Create Domain request
Create Domain Response from the service
The CreateDomain operation creates a new domain. The domain name must be unique
among the domains associated with the Access Key ID provided in the request. The CreateDomain
operation may take 10 or more seconds to complete.
Initiates the asynchronous execution of the ListDomains operation.
The ListDomainsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListDomains.
Finishes the asynchronous execution of the ListDomains operation.
The IAsyncResult returned by the call to BeginListDomains.
Returns a ListDomainsResponse from S3.
List Domains
List Domains request
List Domains Response from the service
The ListDomains operation lists all domains associated with the Access Key ID. It returns
domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more
than MaxNumberOfDomains domains. Calling ListDomains successive times with the
NextToken returns up to MaxNumberOfDomains more domain names each time.
Initiates the asynchronous execution of the DomainMetadata operation.
The DomainMetadataRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDomainMetadata.
Finishes the asynchronous execution of the DomainMetadata operation.
The IAsyncResult returned by the call to BeginDomainMetadata.
Returns a DomainMetadataResponse from S3.
Domain Metadata
Domain Metadata request
Domain Metadata Response from the service
The DomainMetadata operation returns some domain metadata values, such as the
number of items, attribute names and attribute values along with their sizes.
Initiates the asynchronous execution of the DeleteDomain operation.
The DeleteDomainRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteDomain.
Finishes the asynchronous execution of the DeleteDomain operation.
The IAsyncResult returned by the call to BeginDeleteDomain.
Returns a DeleteDomainResponse from S3.
Delete Domain
Delete Domain request
Delete Domain Response from the service
The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain
are deleted as well. The DeleteDomain operation may take 10 or more seconds to complete.
Initiates the asynchronous execution of the PutAttributes operation.
The PutAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutAttributes.
Finishes the asynchronous execution of the PutAttributes operation.
The IAsyncResult returned by the call to BeginPutAttributes.
Returns a PutAttributesResponse from S3.
Put Attributes
Put Attributes request
Put Attributes Response from the service
The PutAttributes operation creates or replaces attributes within an item. You specify new attributes
using a combination of the Attribute.X.Name and Attribute.X.Value parameters. You specify
the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second
attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single
item can have the attributes { "first_name", "first_value" } and { "first_name",
second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and
Attribute.X.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual value. Setting this value
to true will cause the new attribute value to replace the existing attribute value(s). For example, if an
item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor does a
PutAttributes of { 'b', '4' } with the Replace parameter set to true, the final attributes of the
item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute
with the new value.
Initiates the asynchronous execution of the BatchPutAttributes operation.
The BatchPutAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndBatchPutAttributes.
Finishes the asynchronous execution of the BatchPutAttributes operation.
The IAsyncResult returned by the call to BeginBatchPutAttributes.
Returns a BatchPutAttributesResponse from S3.
Batch Put Attributes
Batch Put Attributes request
Batch Put Attributes Response from the service
The BatchPutAttributes operation creates or replaces attributes within one or more items.
You specify the item name with the Item.X.ItemName parameter.
You specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters.
You specify the first attribute for the first item by the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value,
the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single
item can have the attributes { "first_name", "first_value" } and { "first_name",
second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and
Item.X.Attribute.Y.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual value. Setting this value
to true will cause the new attribute value to replace the existing attribute value(s). For example, if an
item 'I' has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor does a
BacthPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the
item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute
with the new value.
Initiates the asynchronous execution of the GetAttributes operation.
The GetAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetAttributes.
Finishes the asynchronous execution of the GetAttributes operation.
The IAsyncResult returned by the call to BeginGetAttributes.
Returns a GetAttributesResponse from S3.
Get Attributes
Get Attributes request
Get Attributes Response from the service
Returns all of the attributes associated with the item. Optionally, the attributes returned can be limited to
the specified AttributeName parameter.
If the item does not exist on the replica that was accessed for this operation, an empty attribute is
returned. The system does not return an error as it cannot guarantee the item does not exist on other
replicas.
Initiates the asynchronous execution of the DeleteAttributes operation.
The DeleteAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteAttributes.
Finishes the asynchronous execution of the DeleteAttributes operation.
The IAsyncResult returned by the call to BeginDeleteAttributes.
Returns a DeleteAttributesResponse from S3.
Delete Attributes
Delete Attributes request
Delete Attributes Response from the service
Deletes one or more attributes associated with the item. If all attributes of an item are deleted, the item is
deleted.
Initiates the asynchronous execution of the BatchDeleteAttributes operation.
The BatchDeleteAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndBatchDeleteAttributes.
Finishes the asynchronous execution of the BatchDeleteAttributes operation.
The IAsyncResult returned by the call to BeginBatchDeleteAttributes.
Returns a BatchDeleteAttributesResponse from S3.
Batch Delete Attributes
Batch Delete Attributes request
BatchDeleteAttributesResponse from the service
The BatchDeleteAttributes operation deletes attributes within one or more items.
An item name and a collection of is specified for each
item to have attributes deleted for. If no attributes are specified then the entire item will be deleted.
Initiates the asynchronous execution of the Select operation.
The SelectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSelect.
Finishes the asynchronous execution of the Select operation.
The IAsyncResult returned by the call to BeginSelect.
Returns a SelectResponse from S3.
Select
Select request
Select Response from the service
The Select operation returns a set of item names and associate attributes that match the
query expression. Select operations that run longer than 5 seconds will likely time-out
and return a time-out error response.
The SetBucketVersioningRequest contains the parameters used for the
SetBucketVersioning operation.
Required Parameters: BucketName, VersioningConfig
MfaCodes property is required if VersioningConfig.EnableMfaDelete = true
If you want to enable the use of a multi-factor authentication device
on this bucket, please set the EnableMfaDelete property of VersioningConfig.
If EnableMfaDelete is set to true, the MfaCodes property needs to be set with the
Serial number and Current Token displayed on the MFA device.
Base class for all S3 operation requests.
Provides a header collection which can is used to store the request headers.
Checks if Headers property is set
true if Headers property is set
Adds all of the key/value pairs from collection into our request header.
A collection of key/value headers
Adds the header to the collection of headers for the request.
The name of the header for example Content-Disposition.
The value to be set for the header.
Sets the InputStream property.
InputStream property
this instance
Checks if InputStream property is set.
true if InputStream property is set.
Gets the Headers property.
Gets and sets the InputStream property.
Sets the BucketName property for this request.
The Versioning Status of this S3 Bucket is modified by the request.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the VersioningConfig property for this request.
The request modifies the Versioning Status of the S3 Bucket to this value.
The value that VersioningConfig is set to
this instance
Checks if VersioningConfig property is set.
true if VersioningConfig property is set.
Sets the MfaCodes property.
The MfaCodes Tuple associates the Serial Number
and the current Token/Code displayed on the
Multi-Factor Authentication device associated with
your AWS Account
Serial number of the authentication device
Token displayed on the authentication device
this instance
Checks if the MfaCodes property is set.
true if the MfaCodes property is set.
Gets and sets the BucketName property.
Gets and sets the VersioningConfig property.
Once Versioning has been "Enabled" on a bucket, it can be "Suspended"
but cannot be switched "Off". If EnableMfaDelete is set,
the MfaCodes property needs to contain the Serial of and current Token
displayed on the MFA device.
Gets and Sets the MfaCodes property.
The MfaCodes Tuple associates the Serial Number
and the current Token/Code displayed on the
Multi-Factor Authentication device associated with
your AWS Account
The GetBucketLoggingResponse contains the GetBucketLoggingResult and
any headers returned by S3.
Base class for all S3 operation responses.
Provides a header collection which is used to store the response headers.
Also exposes the RequestId and AmazonId2 from S3 responses, as well as a
Response Stream is the operation returned a stream.
Lastly, if the response contained metadata, they are stored in the Metadata
collection.
web headers for all requests.
Disposes of all managed and unmanaged resources.
The destructor for the S3Response class.
String Representation of this object. Overrides Object.ToString()
This object as a string
A blank virtual method to allow sub classes to provide
custom response body parsing.
The response from a request to S3
Gets and sets the RequestId property.
Gets and sets the AmzId2 property.
Gets and sets the ResponseStream property. This property
only has a valid value for GetObjectResponses. In order to
use this stream without leaking the underlying resource, please
wrap access to the stream within a using block.
List performance is not substantially affected by the total number of keys in your
bucket, nor by the presence or absence of any additional query parameters.
Initiates the asynchronous execution of the GetACL operation.
The GetACLRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetACL.
Finishes the asynchronous execution of the GetACL operation.
The IAsyncResult returned by the call to BeginGetACL.
Returns a GetACLResponse from S3.
The GetACL operation gets the S3AccessControlList for a given bucket or object.
Each bucket and object in Amazon S3 has an ACL that defines its access control
policy, which is a list of grants. A grant consists of one grantee and one permission.
ACLs only grant permissions; they do not deny them.
The GetACLRequest that defines the parameters of the operation.
Returns a GetACLResponse from S3.
Initiates the asynchronous execution of the SetACL operation.
The SetACLRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSetACL.
Finishes the asynchronous execution of the SetACL operation.
The IAsyncResult returned by the call to BeginSetACL.
Returns a SetACLResponse from S3.
The SetACL operation gets the S3AccessControlList for a given bucket or object.
Each bucket and object in Amazon S3 has an ACL that defines its access control
policy, which is a list of grants. A grant consists of one grantee and one permission.
ACLs only grant permissions; they do not deny them.
Often used ACLs are defined in the S3CannedACL enumeration.
The SetACLRequest that defines the parameters of the operation.
Returns a SetACLResponse from S3.
Initiates the asynchronous execution of the PutBucket operation.
The PutBucketRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutBucket.
Finishes the asynchronous execution of the PutBucket operation.
The IAsyncResult returned by the call to BeginPutBucket.
Returns a PutBucketResponse from S3.
The PutBucket operation creates a new S3 Bucket.
Depending on your latency and legal requirements, you can specify a location
constraint that will affect where your data physically resides.
The PutBucketRequest that defines the parameters of the operation.
Returns a PutBucketResponse from S3.
Every object stored in Amazon S3 is contained in a bucket. Buckets
partition the namespace of objects stored in Amazon S3 at the top level.
Within a bucket, you can use any names for your objects, but bucket names
must be unique across all of Amazon S3.
Buckets are similar to Internet domain names. Just as Amazon is the only owner
of the domain name Amazon.com, only one person or organization can own a bucket
within Amazon S3. The similarities between buckets and domain names is not a
coincidence - there is a direct mapping between Amazon S3 buckets and subdomains
of s3.amazonaws.com. Objects stored in Amazon S3 are addressable using the REST API
under the domain bucketname.s3.amazonaws.com. For example, the object homepage.html
stored in the Amazon S3 bucket mybucket can be addressed as
http://mybucket.s3.amazonaws.com/homepage.html.
To conform with DNS requirements, the following constraints apply:
- Bucket names should not contain underscores (_)
- Bucket names should be between 3 and 63 characters long
- Bucket names should not end with a dash
- Bucket names cannot contain two, adjacent periods
- Bucket names cannot contain dashes next to periods
(e.g., "my-.bucket.com" and "my.-bucket" are invalid)
- Bucket names cannot contain uppercase characters
There is no limit to the number of objects that can be stored in a bucket and no
variation in performance when using many buckets or just a few. You can store all
of your objects in a single bucket or organize them across several buckets.
Initiates the asynchronous execution of the DeleteBucket operation.
The DeleteBucketRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteBucket.
Finishes the asynchronous execution of the DeleteBucket operation.
The IAsyncResult returned by the call to BeginDeleteBucket.
Returns a DeleteBucketResponse from S3.
The DeleteBucket operation deletes the bucket named in the request.
All objects in the bucket must be deleted before the bucket itself can be deleted.
Only the owner of a bucket can delete it, regardless of the bucket's access control policy.
The DeleteBucketRequest that defines the parameters of the operation.
Returns a DeleteBucketResponse from S3.
Initiates the asynchronous execution of the GetObject operation.
The GetObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetObject.
Finishes the asynchronous execution of the GetObject operation.
The IAsyncResult returned by the call to BeginGetObject.
Returns a GetObjectResponse from S3.
The GetObject operation fetches the most recent version of an S3 object
from the specified S3 bucket. You must have READ access to the object.
If READ access is granted to an anonymous user, an object can be retrieved
without an authorization header. Providing a version-id for the object will
fetch the specific version from S3 instead of the most recent one.
The GetObjectRequest that defines the parameters of the operation.
Returns a GetObjectResponse from S3.
Please wrap the response you get from calling GetObject in a using clause.
This ensures that all underlying IO resources allocated for the response
are disposed once the response has been processed. This is one way to
call GetObject:
using (GetObjectResponse response = s3Client.GetObject(request))
{
... Process the response:
Get the Stream, get the content-length, write contents to disk, etc
}
To see what resources are cleaned up at the end of the using block, please
see
Initiates the asynchronous execution of the GetObjectMetadata operation.
The GetObjectMetadataRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetObjectMetadata.
Finishes the asynchronous execution of the GetObjectMetadata operation.
The IAsyncResult returned by the call to BeginGetObjectMetadata.
Returns a GetObjectMetadataResponse from S3.
The GetObjectMetadata operation is used to retrieve information about a specific object
or object size, without actually fetching the object itself. This is useful if you're
only interested in the object metadata, and don't want to waste bandwidth on the object data.
The response is identical to the GetObject response, except that there is no response body.
The GetObjectMetadataRequest that defines the parameters of the operation.
Returns a GetObjectMetadataResponse from S3.
Initiates the asynchronous execution of the PutObject operation.
The PutObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutObject.
Finishes the asynchronous execution of the PutObject operation.
The IAsyncResult returned by the call to BeginPutObject.
Returns a PutObjectResponse from S3.
The PutObject operation adds an object to an S3 Bucket.
The response indicates that the object has been successfully stored.
Amazon S3 never stores partial objects: if you receive a successful
response, then you can be confident that the entire object was stored.
To ensure data is not corrupted over the network, use the Content-MD5
header. When you use the Content-MD5 header, Amazon S3 checks the object
against the provided MD5 value. If they do not match, Amazon S3 returns an error.
Additionally, you can calculate the MD5 while putting an object to
Amazon S3 and compare the returned Etag to the calculated MD5 value.
If an object already exists in a bucket, the new object will overwrite
it because Amazon S3 stores the last write request. However, Amazon S3
is a distributed system. If Amazon S3 receives multiple write requests
for the same object nearly simultaneously, all of the objects might be
stored, even though only one wins in the end. Amazon S3 does not provide
object locking; if you need this, make sure to build it into your application
layer.
If you specify a location constraint when creating a bucket, all objects
added to the bucket are stored in the bucket's location.
You must have WRITE access to the bucket to add an object.
The PutObjectRequest that defines the parameters of the operation.
Returns a PutObjectResponse from S3.
Initiates the asynchronous execution of the DeleteObject operation.
The DeleteObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteObject.
Finishes the asynchronous execution of the DeleteObject operation.
The IAsyncResult returned by the call to BeginDeleteObject.
Returns a DeleteObjectResponse from S3.
The DeleteObject operation removes the specified object from Amazon S3.
Once deleted, there is no method to restore or undelete an object.
If you delete an object that does not exist, Amazon S3 will return a
success (not an error message).
The DeleteObjectRequest that defines the parameters of the operation.
Returns a DeleteObjectResponse from S3.
Initiates the asynchronous execution of the CopyObject operation.
The CopyObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCopyObject.
Finishes the asynchronous execution of the CopyObject operation.
The IAsyncResult returned by the call to BeginCopyObject.
Returns a CopyObjectResponse from S3.
The copy operation creates a copy of an object that is already stored in Amazon S3.
When copying an object, you can preserve all metadata (default) or specify new metadata.
However, the ACL is not preserved and is set to private for the user making the request.
To override the default ACL setting, specify a new ACL when generating a copy request.
If versioning has been enabled on the source bucket, and you want to copy a specific
version of an object, please use
to specify the
version. By default, the most recent version of an object is copied to the
destination bucket.
The CopyObjectRequest that defines the parameters of the operation.
Returns a CopyObjectResponse from S3.
If Versioning has been enabled on the target bucket, S3 generates a
unique version ID for the object being copied. This version ID is different
from the version ID of the source object. Additionally, S3 returns the version
ID of the copied object in the x-amz-version-id response header in the response.
If you do not enable Versioning or suspend it on the target bucket, the version ID
S3 generates is always the string literal - "null".
Initiates the asynchronous execution of the InitiateMultipartUpload operation.
The InitiateMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndInitiateMultipartUpload.
Finishes the asynchronous execution of the InitiateMultipartUpload operation.
The IAsyncResult returned by the call to BeginInitiateMultipartUpload.
Returns a InitiateMultipartUploadResponse from S3.
This method initiates a multipart upload and returns an InitiateMultipartUploadResponse
which contains an upload ID. This upload ID associates all the
parts in the specific upload. You specify this upload ID in each of
your subsequent Upload Part requests. You also include
this upload ID in the final request to either complete, or abort
the multipart upload request.
The CopyObjectRequest that defines the parameters of the operation.
Returns a InitiateMultipartUploadResponse from S3.
Initiates the asynchronous execution of the UploadPart operation.
The UploadPartRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUploadPart.
Finishes the asynchronous execution of the UploadPart operation.
The IAsyncResult returned by the call to BeginUploadPart.
Returns a UploadPartResponse from S3.
This method uploads a part in a multipart upload. You must initiate a
multipart upload before you can upload any part.
Your UploadPart request must include an upload ID and a part number.
The upload ID is the ID returned by Amazon S3 in response to your
Initiate Multipart Upload request. Part number can be any number between 1 and
10,000, inclusive. A part number uniquely identifies a part and also
defines its position within the object being uploaded. If you
upload a new part using the same part number as an existing
part, that part is overwritten.
To ensure data is not corrupted traversing the network, specify the
Content-MD5 header in the Upload Part request. Amazon S3 checks
the part data against the provided MD5 value. If they do not match,
Amazon S3 returns an error.
When you upload a part, the UploadPartResponse response contains an ETag property.
You should record this ETag property value and the part
number. After uploading all parts, you must send a CompleteMultipartUpload
request. At that time Amazon S3 constructs a complete object by
concatenating all the parts you uploaded, in ascending order based on
the part numbers. The CompleteMultipartUpload request requires you to
send all the part numbers and the corresponding ETag values.
The UploadPartRequest that defines the parameters of the operation.
Returns a UploadPartResponse from S3.
Initiates the asynchronous execution of the CopyPart operation.
The CopyPartRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCopyPart.
Finishes the asynchronous execution of the CopyPart operation.
The IAsyncResult returned by the call to BeginCopyPart.
Returns a CopyPartResponse from S3.
This method creates a part in a multipart upload from an existing Amazon S3 Object.
You must initiate a multipart upload before you can copy a part.
Your CopyPart request must include an upload ID and a part number.
The upload ID is the ID returned by Amazon S3 in response to your
Initiate Multipart Upload request. Part number can be any number between 1 and
10,000, inclusive. A part number uniquely identifies a part and also
defines its position within the object being uploaded. If you
copy a part using the same part number as an existing part, that part is overwritten.
When you copy a part, the CopyPartResponse response contains an ETag property.
You should record this ETag property value and the part
number. After uploading all parts, you must send a CompleteMultipartUpload
request. At that time Amazon S3 constructs a complete object by
concatenating all the parts you uploaded, in ascending order based on
the part numbers. The CompleteMultipartUpload request requires you to
send all the part numbers and the corresponding ETag values.
The CopyPartRequest that defines the parameters of the operation.
Returns a CopyPartResponse from S3.
Initiates the asynchronous execution of the ListParts operation.
The ListPartsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListParts.
Finishes the asynchronous execution of the ListParts operation.
The IAsyncResult returned by the call to BeginListParts.
Returns a ListPartsResponse from S3.
This method lists the parts that have been uploaded
for a particular multipart upload.
This method must include the upload ID, returned by
the InitiateMultipartUpload request. This request
returns a maximum of 1000 uploaded parts by default. You can
restrict the number of parts returned by specifying the
MaxParts property on the ListPartsRequest. If your multipart
upload consists of more parts than allowed in the
ListParts response, the response returns a IsTruncated
field with value true, and a NextPartNumberMarker property.
In subsequent ListParts request you can include the
PartNumberMarker property and set its value to the
NextPartNumberMarker property value from the previous response.
The ListPartsRequest that defines the parameters of the operation.
Returns a ListPartsResponse from S3.
Initiates the asynchronous execution of the AbortMultipartUpload operation.
The AbortMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndAbortMultipartUpload.
Finishes the asynchronous execution of the AbortMultipartUpload operation.
The IAsyncResult returned by the call to BeginAbortMultipartUpload.
Returns a AbortMultipartUploadResponse from S3.
This method aborts a multipart upload. After a multipart upload is
aborted, no additional parts can be uploaded using that upload ID.
The storage consumed by any previously uploaded parts will be freed.
However, if any part uploads are currently in progress, those part
uploads may or may not succeed. As a result, it may be necessary to
abort a given multipart upload multiple times in order to completely free
all storage consumed by all parts.
The AbortMultipartUploadRequest that defines the parameters of the operation.
Returns a AbortMultipartUploadResponse from S3.
Initiates the asynchronous execution of the CompleteMultipartUpload operation.
The CompleteMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCompleteMultipartUpload.
Finishes the asynchronous execution of the CompleteMultipartUpload operation.
The IAsyncResult returned by the call to BeginCompleteMultipartUpload.
Returns a CompleteMultipartUploadResponse from S3.
This operation completes a multipart upload by assembling
previously uploaded parts.
You first upload all parts using the UploadPart method.
After successfully uploading all relevant parts of an upload,
you call this operation to complete the upload. Upon receiving
this request, Amazon S3 concatenates all the parts in ascending
order by part number to create a new object. In the
CompleteMultipartUpload request, you must provide the
parts list. For each part in the list, you provide the
part number and the ETag header value, returned after that
part was uploaded.
Processing of a CompleteMultipartUpload request may take
several minutes to complete.
The CompleteMultipartUploadRequest that defines the parameters of the operation.
Returns a CompleteMultipartUploadResponse from S3.
Initiates the asynchronous execution of the ListMultipartUploads operation.
The ListMultipartUploadsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListMultipartUploads.
Finishes the asynchronous execution of the ListMultipartUploads operation.
The IAsyncResult returned by the call to BeginListMultipartUploads.
Returns a ListMultipartUploadsResponse from S3.
This operation lists in-progress multipart uploads. An in-progress
multipart upload is a multipart upload that has been initiated,
using the InitiateMultipartUpload request, but has not yet been
completed or aborted.
This operation returns at most 1,000 multipart uploads in the
response by default. The number of multipart uploads can be further
limited using the MaxUploads property on the request parameter. If there are
additional multipart uploads that satisfy the list criteria, the
response will contain an IsTruncated property with the value set to true.
To list the additional multipart uploads use the KeyMarker and
UploadIdMarker properties on the request parameters.
The ListMultipartUploadsRequest that defines the parameters of the operation.
Returns a ListMultipartUploadsResponse from S3.
Initiates the asynchronous execution of the PutBucketWebsite operation.
The PutBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutBucketWebsite.
Finishes the asynchronous execution of the PutBucketWebsite operation.
The IAsyncResult returned by the call to BeginPutBucketWebsite.
Returns a PutBucketWebsiteResponse from S3.
This operation enables/configures an S3 Website using the corresponding bucket as the content source.
The website will have one default domain name associated with it, which is the bucket name.
If you attempt to configure an S3 website for a bucket whose name is not compatible with DNS,
Amazon S3 returns an InvalidBucketName error. For more information on bucket names and DNS,
refer to Bucket Restrictions and Limitations.
To visit the S3 bucket as a website a new endpoint is created in the following pattern
http://<bucketName>.s3-website-<region>.amazonaws.com/. This is a sample url for a bucket
called example-bucket in the us-east-1 region. http://example-bucket.s3-website-us-east-1.amazonaws.com/
The PutBucketWebsiteRequest that defines the parameters of the operation.
Returns a PutBucketWebsiteResponse from S3.
Initiates the asynchronous execution of the GetBucketWebsite operation.
The GetBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketWebsite.
Finishes the asynchronous execution of the GetBucketWebsite operation.
The IAsyncResult returned by the call to BeginGetBucketWebsite.
Returns a GetBucketWebsiteResponse from S3.
This operation retrieves the website configuration for a bucket. The contents of this response
is identical to the content submitted by the user during the PutBucketWebsite operation if it has ever been configured.
The GetBucketWebsiteRequest that defines the parameters of the operation.
Returns a GetBucketWebsiteResponse from S3.
Initiates the asynchronous execution of the DeleteBucketWebsite operation.
The DeleteBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteBucketWebsite.
Finishes the asynchronous execution of the DeleteBucketWebsite operation.
The IAsyncResult returned by the call to BeginDeleteBucketWebsite.
Returns a DeleteBucketWebsiteResponse from S3.
This operation removes the website configuration for a bucket.
The DeleteBucketWebsiteRequest that defines the parameters of the operation.
Returns a DeleteBucketWebsiteResponse from S3.
A base exception for some Amazon Web Services.
Most exceptions thrown to client code will be service-specific exceptions, though some services
may throw this exception if there is a problem which is caught in the core client code.
Whether the error was attributable to Sender or Reciever.
The error code returned by the service
The id of the request which generated the exception.
The HTTP status code from the service response
Reset D B Parameter Group Request Marshaller
Result Unmarshaller for RebootDBInstance operation
IPRange Unmarshaller
Response Unmarshaller for DescribeEngineDefaultParameters operation
Create D B Instance Read Replica Request Marshaller
AmazonRDS exception
Constructs a new ReservedDBInstanceNotFoundException with the specified error
message.
Describes the error encountered.
This data type is used as a response element in the DescribeEvents action.
Sets the SourceIdentifier property
The value to set for the SourceIdentifier property
this instance
Sets the SourceType property
The value to set for the SourceType property
this instance
Sets the Message property
The value to set for the Message property
this instance
Sets the Date property
The value to set for the Date property
this instance
Provides the identifier for the source of the event.
Specifies the source type for this event.
Constraints:
-
Allowed Values
db-instance, db-parameter-group, db-security-group, db-snapshot
Provides the text of this event.
Specifies the date and time of the event.
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the ReservedDBInstances collection
The values to add to the ReservedDBInstances collection
this instance
Adds elements to the ReservedDBInstances collection
The values to add to the ReservedDBInstances collection
this instance
The marker provided for paginated results.
A list of of reserved DB Instances.
AmazonRDS exception
Constructs a new DBParameterGroupQuotaExceededException with the specified error
message.
Describes the error encountered.
The results from the CreateDBSnapshot action.
Abstract class for Response objects, contains only metadata,
and no result information.
Contains additional information about the request, such as the
Request Id.
Gets and sets the CreateDBSnapshotResult property.
Contains the result of a successful invocation of the CreateDBSnapshot
action.
UpdateJobResult Unmarshaller
AmazonImportExport exception
Constructs a new CanceledJobIdException with the specified error
message.
Describes the error encountered.
Returns information about the UploadSigningCertificateResult response and response metadata.
Gets and sets the UploadSigningCertificateResult property.
Contains the result of a successful invocation of the UploadSigningCertificate action.
Returns information about the UpdateSigningCertificate response metadata.
The UpdateSigningCertificate operation has a void result type.
Container for the parameters to the UpdateSigningCertificate operation.
Changes the status of the specified signing certificate from
active to disabled, or vice versa. This action can be used to disable
a User's signing certificate as part of a certificate rotation
workflow. If the UserName field is not specified,
the UserName is determined implicitly based on the AWS Access Key ID
used to sign the request. Because this action works for access keys
under the AWS Account, this API can be used to manage root credentials
even if the AWS Account has no associated Users. For
information about rotating certificates, see Managing Keys and
Certificates in Using AWS Identity and Access Management
.
Base class for request used by some of the services.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the CertificateId property
The value to set for the CertificateId property
this instance
Sets the Status property
The value to set for the Status property
this instance
Name of the User the signing certificate belongs to.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The ID of the signing certificate you want to update.
Constraints:
-
Length
24 - 128
-
Pattern
[\w]*
The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while
Inactive means the certificate cannot be used.
Constraints:
-
Allowed Values
Active, Inactive
Returns information about the UpdateAccessKey response metadata.
The UpdateAccessKey operation has a void result type.
List Users Request Marshaller
ListUserPoliciesResult Unmarshaller
Response Unmarshaller for ListMFADevices operation
Response Unmarshaller for ListGroupsForUser operation
Get User Request Marshaller
Response Unmarshaller for DeleteUserPolicy operation
Response Unmarshaller for CreateGroup operation
CreateAccessKeyResult Unmarshaller
Container for the parameters to the PutUserPolicy operation.
Adds (or updates) a policy document associated with the
specified User. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a User, see Limitations on IAM Entities in Using AWS
Identity and Access Management . NOTE:Because
policy documents can be large, you should use POST rather than GET
when calling PutUserPolicy. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the PolicyDocument property
The value to set for the PolicyDocument property
this instance
Name of the User to associate the policy with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The policy document.
Constraints:
-
Length
1 - 131072
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Returns information about the ListSigningCertificatesResult response and response metadata.
Gets and sets the ListSigningCertificatesResult property.
Contains the result of a successful invocation of the ListSigningCertificates action.
Returns information about the ListGroupPoliciesResult response and response metadata.
Gets and sets the ListGroupPoliciesResult property.
Contains the result of a successful invocation of the ListGroupPolicies action.
The Group data type contains information about a group.
This data type is used as a response element in the following
actions:
- CreateGroup
- GetGroup
- ListGroups
Sets the Path property
The value to set for the Path property
this instance
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the GroupId property
The value to set for the GroupId property
this instance
Sets the Arn property
The value to set for the Arn property
this instance
Sets the CreateDate property
The value to set for the CreateDate property
this instance
Path to the group. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
The name that identifies the group.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
20 - 2048
The date when the group was created.
Returns information about the GetUserPolicyResult response and response metadata.
Gets and sets the GetUserPolicyResult property.
Contains the result of a successful invocation of the GetUserPolicy action.
AmazonIdentityManagementService exception
Constructs a new DeleteConflictException with the specified error
message.
Describes the error encountered.
Returns information about the DeleteAccessKey response metadata.
The DeleteAccessKey operation has a void result type.
Returns information about the CreateAccountAlias response metadata.
The CreateAccountAlias operation has a void result type.
The AccessKey data type contains information about an AWS access
key. This data type is used as a response element in the
actions CreateAccessKey and ListAccessKeys.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the AccessKeyId property
The value to set for the AccessKeyId property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the SecretAccessKey property
The value to set for the SecretAccessKey property
this instance
Sets the CreateDate property
The value to set for the CreateDate property
this instance
Name of the User the key is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The ID for this access key.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
Constraints:
-
Allowed Values
Active, Inactive
The secret key used to sign requests.
The date when the access key was created.
Interface for accessing AmazonIdentityManagementService.
AWS Identity and Access Management This is the AWS Identity and
Access Management (IAM) API Reference. This guide provides
descriptions of the IAM API as well as links to related content in the
guide, Using IAM. AWS Identity and Access Management
(IAM) is a web service that enables Amazon Web Services (AWS)
customers to manage Users and User permissions under their AWS
Account. For more information about this product go to
AWS Identity and Access Management (IAM). For specific information
about setting up signatures and authorization through the API, go to
Making Query Requests in the Using IAM guide. If you're
new to AWS and need additional technical information about a specific
AWS product, you can find the product's technical documentation at
http://aws.amazon.com/documentation/. We will refer to
Amazon AWS Identity and Access Management using the abbreviated form
IAM. All copyrights and legal protections still apply.
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary parameters
to execute the ListGroups service method on
AmazonIdentityManagementService.
The response from the ListGroups service method, as returned
by AmazonIdentityManagementService.
Deletes the access key associated with the specified
User. If you do not specify a User name, IAM determines
the User name implicitly based on the AWS Access Key ID signing the
request. Because this action works for access keys under the AWS
Account, you can use this API to manage root credentials even if the
AWS Account has no associated Users.
Container for the necessary
parameters to execute the DeleteAccessKey service method on
AmazonIdentityManagementService.
Deletes the specified AWS Account alias. For information about
using an AWS Account alias, see Using an Alias for Your AWS Account ID
in Using AWS Identity and Access Management .
Container for the necessary
parameters to execute the DeleteAccountAlias service method on
AmazonIdentityManagementService.
Returns information about the signing certificates associated
with the specified User. If there are none, the action returns an
empty list. Although each User is limited to a small
number of signing certificates, you can still paginate the results
using the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is
determined implicitly based on the AWS Access Key ID used to sign the
request. Because this action works for access keys under the AWS
Account, this API can be used to manage root credentials even if the
AWS Account has no associated Users.
Container for the
necessary parameters to execute the ListSigningCertificates service
method on AmazonIdentityManagementService.
The response from the ListSigningCertificates service method,
as returned by AmazonIdentityManagementService.
Uploads an X.509 signing certificate and associates it with the
specified User. Some AWS services use X.509 signing certificates to
validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is Active
. If the UserName field is not specified, the User
name is determined implicitly based on the AWS Access Key ID used to
sign the request. Because this action works for access keys under the
AWS Account, this API can be used to manage root credentials even if
the AWS Account has no associated Users.
NOTE:Because the body of a X.509 certificate can be
large, you should use POST rather than GET when calling
UploadSigningCertificate. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Container for the
necessary parameters to execute the UploadSigningCertificate service
method on AmazonIdentityManagementService.
The response from the UploadSigningCertificate service
method, as returned by AmazonIdentityManagementService.
Deletes the specified policy associated with the specified
User.
Container for the necessary
parameters to execute the DeleteUserPolicy service method on
AmazonIdentityManagementService.
Adds (or updates) a policy document associated with the
specified User. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a User, see Limitations on IAM Entities in Using AWS
Identity and Access Management . NOTE:Because
policy documents can be large, you should use POST rather than GET
when calling PutUserPolicy. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Container for the necessary
parameters to execute the PutUserPolicy service method on
AmazonIdentityManagementService.
Lists the server certificates that have the specified path
prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the
necessary parameters to execute the ListServerCertificates service
method on AmazonIdentityManagementService.
The response from the ListServerCertificates service method,
as returned by AmazonIdentityManagementService.
Retrieves the specified policy document for the specified User.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Container for the necessary
parameters to execute the GetUserPolicy service method on
AmazonIdentityManagementService.
The response from the GetUserPolicy service method, as
returned by AmazonIdentityManagementService.
Updates the login profile for the specified User. Use this API
to change the User's password.
Container for the necessary
parameters to execute the UpdateLoginProfile service method on
AmazonIdentityManagementService.
Updates the name and/or the path of the specified server
certificate. IMPORTANT: You should understand the
implications of changing a server certificate's path or name. For more
information, see Managing Server Certificates in Using AWS Identity
and Access Management. NOTE:To change a server
certificate name the requester must have appropriate permissions on
both the source object and the target object. For example, to change
the name from ProductionCert to ProdCert, the entity making the
request must have permission on ProductionCert and ProdCert, or must
have permission on all (*). For more information about permissions,
see Permissions and Policies.
Container for the
necessary parameters to execute the UpdateServerCertificate service
method on AmazonIdentityManagementService.
Updates the name and/or the path of the specified User.
IMPORTANT: You should understand the implications of
changing a User's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a User name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Bob to Robert, the entity making the
request must have permission on Bob and Robert, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Container for the necessary parameters
to execute the UpdateUser service method on
AmazonIdentityManagementService.
Deletes the login profile for the specified User, which
terminates the User's ability to access AWS services through the IAM
login page. IMPORTANT:Deleting a User's login
profile does not prevent a User from accessing IAM through the command
line interface or the API. To prevent all User access you must also
either make the access key inactive or delete it. For more
information about making keys inactive or deleting them, see
UpdateAccessKey and DeleteAccessKey.
Container for the necessary
parameters to execute the DeleteLoginProfile service method on
AmazonIdentityManagementService.
Changes the status of the specified signing certificate from
active to disabled, or vice versa. This action can be used to disable
a User's signing certificate as part of a certificate rotation
workflow. If the UserName field is not specified,
the UserName is determined implicitly based on the AWS Access Key ID
used to sign the request. Because this action works for access keys
under the AWS Account, this API can be used to manage root credentials
even if the AWS Account has no associated Users. For
information about rotating certificates, see Managing Keys and
Certificates in Using AWS Identity and Access Management
.
Container for the
necessary parameters to execute the UpdateSigningCertificate service
method on AmazonIdentityManagementService.
Deletes the specified policy that is associated with the
specified group.
Container for the necessary
parameters to execute the DeleteGroupPolicy service method on
AmazonIdentityManagementService.
Lists the Users that have the specified path prefix. If there
are none, the action returns an empty list. You can
paginate the results using the MaxItems and Marker
parameters.
Container for the necessary parameters
to execute the ListUsers service method on
AmazonIdentityManagementService.
The response from the ListUsers service method, as returned
by AmazonIdentityManagementService.
Updates the name and/or the path of the specified group.
IMPORTANT: You should understand the implications of
changing a group's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a group name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Managers to MGRs, the entity making
the request must have permission on Managers and MGRs, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Container for the necessary
parameters to execute the UpdateGroup service method on
AmazonIdentityManagementService.
Retrieves information about the specified server
certificate.
Container for the necessary
parameters to execute the GetServerCertificate service method on
AmazonIdentityManagementService.
The response from the GetServerCertificate service method, as
returned by AmazonIdentityManagementService.
Adds (or updates) a policy document associated with the
specified group. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a group, see Limitations on IAM Entities in Using
AWS Identity and Access Management .
NOTE:Because policy documents can be large, you should
use POST rather than GET when calling PutGroupPolicy. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Container for the necessary
parameters to execute the PutGroupPolicy service method on
AmazonIdentityManagementService.
Creates a new User for your AWS Account. For
information about limitations on the number of Users you can create,
see Limitations on IAM Entities in Using AWS Identity and Access
Management .
Container for the necessary parameters
to execute the CreateUser service method on
AmazonIdentityManagementService.
The response from the CreateUser service method, as returned
by AmazonIdentityManagementService.
Deletes the specified signing certificate associated with the
specified User. If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users.
Container for the
necessary parameters to execute the DeleteSigningCertificate service
method on AmazonIdentityManagementService.
Enables the specified MFA device and associates it with the
specified User name. When enabled, the MFA device is required for
every subsequent login by the User name associated with the
device.
Container for the necessary
parameters to execute the EnableMFADevice service method on
AmazonIdentityManagementService.
Lists the names of the policies associated with the specified
User. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary
parameters to execute the ListUserPolicies service method on
AmazonIdentityManagementService.
The response from the ListUserPolicies service method, as
returned by AmazonIdentityManagementService.
Returns information about the Access Key IDs associated with the
specified User. If there are none, the action returns an empty
list. Although each User is limited to a small number of
keys, you can still paginate the results using the MaxItems and
Marker parameters. If the UserName field is
not specified, the UserName is determined implicitly based on the AWS
Access Key ID used to sign the request. Because this action works for
access keys under the AWS Account, this API can be used to manage root
credentials even if the AWS Account has no associated Users.
NOTE:To ensure the security of your AWS Account, the
secret access key is accessible only during key and User
creation.
Container for the necessary
parameters to execute the ListAccessKeys service method on
AmazonIdentityManagementService.
The response from the ListAccessKeys service method, as
returned by AmazonIdentityManagementService.
Retrieves the login profile for the specified User.
Container for the necessary
parameters to execute the GetLoginProfile service method on
AmazonIdentityManagementService.
The response from the GetLoginProfile service method, as
returned by AmazonIdentityManagementService.
Lists the groups the specified User belongs to. You
can paginate the results using the MaxItems and Marker
parameters.
Container for the necessary
parameters to execute the ListGroupsForUser service method on
AmazonIdentityManagementService.
The response from the ListGroupsForUser service method, as
returned by AmazonIdentityManagementService.
Creates a new group. For information about the
number of groups you can create, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
Container for the necessary
parameters to execute the CreateGroup service method on
AmazonIdentityManagementService.
The response from the CreateGroup service method, as returned
by AmazonIdentityManagementService.
Uploads a server certificate entity for the AWS Account. The
server certificate entity includes a public key certificate, a private
key, and an optional certificate chain, which should all be
PEM-encoded. For information about the number of server
certificates you can upload, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
NOTE:Because the body of the public key certificate,
private key, and the certificate chain can be large, you should use
POST rather than GET when calling UploadServerCertificate. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Container for the
necessary parameters to execute the UploadServerCertificate service
method on AmazonIdentityManagementService.
The response from the UploadServerCertificate service method,
as returned by AmazonIdentityManagementService.
This action creates an alias for your AWS Account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
.
Container for the necessary
parameters to execute the CreateAccountAlias service method on
AmazonIdentityManagementService.
Retrieves the specified policy document for the specified group.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Container for the necessary
parameters to execute the GetGroupPolicy service method on
AmazonIdentityManagementService.
The response from the GetGroupPolicy service method, as
returned by AmazonIdentityManagementService.
Deletes the specified User. The User must not belong to any
groups, have any keys or signing certificates, or have any attached
policies.
Container for the necessary parameters
to execute the DeleteUser service method on
AmazonIdentityManagementService.
Deactivates the specified MFA device and removes it from
association with the User name for which it was originally
enabled.
Container for the necessary
parameters to execute the DeactivateMFADevice service method on
AmazonIdentityManagementService.
Removes the specified User from the specified group.
Container for the necessary
parameters to execute the RemoveUserFromGroup service method on
AmazonIdentityManagementService.
Deletes the specified server certificate.
IMPORTANT:If your Elastic Load Balancing instances are
using a server certificate, deleting the certificate could have
implications for your application. If your Elastic Load Balancing
instances do not detect the deletion of bound certificates, they may
continue to use the certificates. This could cause them to stop
accepting traffic. We recommend that you remove the reference to the
certificate from your Elastic Load Balancing instances before using
this command to delete the certificate.
Container for the
necessary parameters to execute the DeleteServerCertificate service
method on AmazonIdentityManagementService.
Lists the names of the policies associated with the specified
group. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary
parameters to execute the ListGroupPolicies service method on
AmazonIdentityManagementService.
The response from the ListGroupPolicies service method, as
returned by AmazonIdentityManagementService.
Creates a login profile for the specified User, giving the User
the ability to access AWS services such as the AWS Management Console.
For more information about login profiles, see Managing Login
Profiles and MFA Devices in Using AWS Identity and Access
Management .
Container for the necessary
parameters to execute the CreateLoginProfile service method on
AmazonIdentityManagementService.
The response from the CreateLoginProfile service method, as
returned by AmazonIdentityManagementService.
Creates a new AWS Secret Access Key and corresponding AWS Access
Key ID for the specified User. The default status for new keys is
Active . If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users. For
information about limits on the number of keys you can create, see
Limitations on IAM Entities in Using AWS Identity and Access
Management . IMPORTANT:To ensure the security
of your AWS Account, the Secret Access Key is accessible only during
key and User creation. You must save the key (for example, in a text
file) if you want to be able to access it again. If a secret key is
lost, you can delete the access keys for the associated User and then
create new keys.
Container for the necessary
parameters to execute the CreateAccessKey service method on
AmazonIdentityManagementService.
The response from the CreateAccessKey service method, as
returned by AmazonIdentityManagementService.
Retrieves information about the specified User, including the
User's path, GUID, and ARN. If you do not specify a User
name, IAM determines the User name implicitly based on the AWS Access
Key ID signing the request.
Container for the necessary parameters to
execute the GetUser service method on
AmazonIdentityManagementService.
The response from the GetUser service method, as returned by
AmazonIdentityManagementService.
Synchronizes the specified MFA device with AWS servers.
Container for the necessary
parameters to execute the ResyncMFADevice service method on
AmazonIdentityManagementService.
Lists the MFA devices associated with the specified User
name. You can paginate the results using the
MaxItems and Marker parameters.
Container for the necessary
parameters to execute the ListMFADevices service method on
AmazonIdentityManagementService.
The response from the ListMFADevices service method, as
returned by AmazonIdentityManagementService.
Changes the status of the specified access key from Active to
Inactive, or vice versa. This action can be used to disable a User's
key as part of a key rotation workflow. If the
UserName field is not specified, the UserName is determined
implicitly based on the AWS Access Key ID used to sign the request.
Because this action works for access keys under the AWS Account, this
API can be used to manage root credentials even if the AWS Account has
no associated Users. For information about rotating keys,
see Managing Keys and Certificates in Using AWS Identity and Access
Management .
Container for the necessary
parameters to execute the UpdateAccessKey service method on
AmazonIdentityManagementService.
Retrieves account level information about account entity usage
and IAM quotas. For information about limitations on IAM
entities, see Limitations on IAM Entities in Using AWS Identity and
Access Management .
Container for the necessary
parameters to execute the GetAccountSummary service method on
AmazonIdentityManagementService.
The response from the GetAccountSummary service method, as
returned by AmazonIdentityManagementService.
Adds the specified User to the specified group.
Container for the necessary
parameters to execute the AddUserToGroup service method on
AmazonIdentityManagementService.
Returns a list of Users that are in the specified group. You can
paginate the results using the MaxItems and Marker
parameters.
Container for the necessary parameters
to execute the GetGroup service method on
AmazonIdentityManagementService.
The response from the GetGroup service method, as returned by
AmazonIdentityManagementService.
Lists the account aliases associated with the account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
. You can paginate the results using the MaxItems
and Marker parameters.
Container for the necessary
parameters to execute the ListAccountAliases service method on
AmazonIdentityManagementService.
The response from the ListAccountAliases service method, as
returned by AmazonIdentityManagementService.
Deletes the specified group. The group must not contain any
Users or have any attached policies.
Container for the necessary
parameters to execute the DeleteGroup service method on
AmazonIdentityManagementService.
Response Unmarshaller for TerminateJobFlows operation
Modify Instance Groups Request Marshaller
HadoopJarStepConfig Unmarshaller
Interface for accessing AmazonElasticMapReduce.
This is the Amazon Elastic MapReduce API Reference Guide. This
guide is for programmers who need detailed information about the
Amazon Elastic MapReduce APIs.
AddInstanceGroups adds an instance group to a running
cluster.
Container for the necessary
parameters to execute the AddInstanceGroups service method on
AmazonElasticMapReduce.
The response from the AddInstanceGroups service method, as
returned by AmazonElasticMapReduce.
AddJobFlowSteps adds new steps to a running job flow. A maximum
of 256 steps are allowed in each job flow. A step
specifies the location of a JAR file stored either on the master node
of the job flow or in Amazon S3. Each step is performed by the main
function of the main class of the JAR file. The main class can be
specified either in the manifest of the JAR or by using the
MainFunction parameter of the step. Elastic MapReduce
executes each step in the order listed. For a step to be considered
complete, the main function must exit with a zero exit code and all
Hadoop jobs started while the step was running must have completed and
run successfully. You can only add steps to a job flow
that is in one of the following states: STARTING, BOOTSTAPPING,
RUNNING, or WAITING.
Container for the necessary
parameters to execute the AddJobFlowSteps service method on
AmazonElasticMapReduce.
TerminateJobFlows shuts a list of job flows down. When a job
flow is shut down, any step not yet completed is canceled and the EC2
instances on which the job flow is running are stopped. Any log files
not already saved are uploaded to Amazon S3 if a LogUri was specified
when the job flow was created.
Container for the necessary
parameters to execute the TerminateJobFlows service method on
AmazonElasticMapReduce.
DescribeJobFlows returns a list of job flows that match all of
the supplied parameters. The parameters can include a list of job flow
IDs, job flow states, and restrictions on job flow creation date and
time. Regardless of supplied parameters, only job flows
created within the last two months are returned. If no
parameters are supplied, then job flows matching either of the
following criteria are returned:
- Job flows created and completed in the last two weeks
- Job flows created within the last two months that are in one of
the following states: RUNNING ,
WAITING ,
SHUTTING_DOWN ,
STARTING
Amazon Elastic MapReduce can return a maximum of 512 job flow
descriptions.
Container for the necessary
parameters to execute the DescribeJobFlows service method on
AmazonElasticMapReduce.
The response from the DescribeJobFlows service method, as
returned by AmazonElasticMapReduce.
RunJobFlow creates and starts running a new job flow. The job
flow will run the steps specified. Once the job flow completes, the
cluster is stopped and the HDFS partition is lost. To prevent loss of
data, configure the last step of the job flow to store results in
Amazon S3. If the JobFlowInstancesDetail : KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE , the job flow will transition to the
WAITING state rather than shutting down once the steps have completed.
A maximum of 256 steps are allowed in each job
flow. For long running job flows, we recommended that you
periodically store your results.
Container for the necessary parameters
to execute the RunJobFlow service method on
AmazonElasticMapReduce.
The response from the RunJobFlow service method, as returned
by AmazonElasticMapReduce.
ModifyInstanceGroups modifies the number of nodes and
configuration settings of an instance group. The input parameters
include the new target instance count for the group and the instance
group ID. The call will either succeed or fail atomically.
Container for the necessary
parameters to execute the ModifyInstanceGroups service method on
AmazonElasticMapReduce.
Response Unmarshaller for SetLoadBalancerPoliciesOfListener operation
Response Unmarshaller for SetLoadBalancerListenerSSLCertificate operation
Instance Unmarshaller
Response Unmarshaller for DescribeLoadBalancers operation
Delete Load Balancer Policy Request Marshaller
Response Unmarshaller for ConfigureHealthCheck operation
Configure Health Check Request Marshaller
The output for the DeregisterInstancesFromLoadBalancer action.
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
An updated list of remaining instances registered with the LoadBalancer.
Container for the parameters to the DeleteLoadBalancer operation.
Deletes the specified LoadBalancer. If attempting to recreate the LoadBalancer, the client must reconfigure all the
settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of
the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to client instances. The client
will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created. To successfully call
this API, the client must provide the same account credentials as were used to create the LoadBalancer. NOTE: By
design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds.
Default constructor for a new DeleteLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DeleteLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
Container for the parameters to the CreateLBCookieStickinessPolicy operation.
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified
expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy,
the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it
first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified
in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the
cookie is based on the cookie expiration time, which is specified in the policy configuration.
Default constructor for a new CreateLBCookieStickinessPolicyRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new CreateLBCookieStickinessPolicyRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the CookieExpirationPeriod property
The value to set for the CookieExpirationPeriod property
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky
session will last for the duration of the browser session.
ValidateConfigurationSettingsResult Unmarshaller
Request Environment Info Request Marshaller
ListAvailableSolutionStacksResult Unmarshaller
DescribeApplicationVersionsResult Unmarshaller
Response Unmarshaller for DescribeApplications operation
Create Configuration Template Request Marshaller
Returns information about the SwapEnvironmentCNAMEs response metadata.
The SwapEnvironmentCNAMEs operation has a void result type.
Describes a LoadBalancer.
Sets the Name property
The value to set for the Name property
this instance
The name of the LoadBalancer.
Returns information about the ListAvailableSolutionStacksResult response and response metadata.
Gets and sets the ListAvailableSolutionStacksResult property.
A list of available AWS Elastic Beanstalk solution stacks.
Container for the parameters to the CreateStorageLocation operation.
Creates the Amazon S3 storage location for the account. This location is used to store user log files.
Implemenation for accessing AmazonElasticBeanstalk.
AWS Elastic Beanstalk This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic
Beanstalk actions, data types, parameters, and errors. AWS Elastic Beanstalk is a tool that makes it easy for you to create,
deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. For more information
about this product, go to the AWS Elastic Beanstalk details page. For specific information about setting up signatures and authorization
through the API, go to the AWS Elastic Beanstalk User Guide. The location of the lastest AWS Elastic Beanstalk WSDL is
http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. Endpoints AWS Elastic
Beanstalk supports the following region-specific endpoint:
- https://elasticbeanstalk.us-east-1.amazonaws.com
A base class for service clients that handles making the actual requests
and possibly retries if needed.
Implements the Dispose pattern for the AmazonWebServiceClient
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings.
The internal wrapped request.
The data to be sent for the request.
The web request that actually makes the call.
This method makes the actual web request and marshalls the response body or error returned from the service.
For some error response a retry will be attempted after an exponential pause.
The user facing request type.
The user facing response type.
The wrapper around the user facing request.
The type of signer to use for the request.
The object used to unmarshall the response body.
The response object for the request
Returns true if a failed request should be retried.
The HTTP status code from the failed request
The client config
The exception from the failed request
The number of times the current request has been attempted
True if the failed request should be retried.
Exponential sleep on failed request to avoid flooding a service with
retries.
Current retry count.
Interface for accessing AmazonElasticBeanstalk.
AWS Elastic Beanstalk This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic
Beanstalk actions, data types, parameters, and errors. AWS Elastic Beanstalk is a tool that makes it easy for you to create,
deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. For more information
about this product, go to the AWS Elastic Beanstalk details page. For specific information about setting up signatures and authorization
through the API, go to the AWS Elastic Beanstalk User Guide. The location of the lastest AWS Elastic Beanstalk WSDL is
http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. Endpoints AWS Elastic
Beanstalk supports the following region-specific endpoint:
- https://elasticbeanstalk.us-east-1.amazonaws.com
Checks if the specified CNAME is available.
Container for the necessary parameters to execute the CheckDNSAvailability service method on
AmazonElasticBeanstalk.
The response from the CheckDNSAvailability service method, as returned by AmazonElasticBeanstalk.
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution
stack defines. The description includes the values the options, their default values, and an indication of the required action on a running
environment if an option value is changed.
Container for the necessary parameters to execute the DescribeConfigurationOptions service
method on AmazonElasticBeanstalk.
The response from the DescribeConfigurationOptions service method, as returned by AmazonElasticBeanstalk.
Deletes the specified configuration template. NOTE:When you launch an environment using a configuration template,
the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running
environment.
Container for the necessary parameters to execute the DeleteConfigurationTemplate service
method on AmazonElasticBeanstalk.
Launches an environment for the specified application using the specified configuration.
Container for the necessary parameters to execute the CreateEnvironment service method on
AmazonElasticBeanstalk.
The response from the CreateEnvironment service method, as returned by AmazonElasticBeanstalk.
Creates the Amazon S3 storage location for the account. This location is used to store user log files.
Container for the necessary parameters to execute the CreateStorageLocation service method on
AmazonElasticBeanstalk.
The response from the CreateStorageLocation service method, as returned by AmazonElasticBeanstalk.
Initiates a request to compile the specified type of information of the deployed environment. Setting the
InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your
environment. Use RetrieveEnvironmentInfo to access the compiled information. Related Topics
Container for the necessary parameters to execute the RequestEnvironmentInfo service method on
AmazonElasticBeanstalk.
Creates an application version for the specified application. NOTE:Once you create an application version with a
specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an
exception when you attempt to launch an environment from the application version.
Container for the necessary parameters to execute the CreateApplicationVersion service method
on AmazonElasticBeanstalk.
The response from the CreateApplicationVersion service method, as returned by AmazonElasticBeanstalk.
Deletes the specified version from the specified application. NOTE:You cannot delete an application version that
is associated with a running environment.
Container for the necessary parameters to execute the DeleteApplicationVersion service method
on AmazonElasticBeanstalk.
Returns descriptions for existing application versions.
Container for the necessary parameters to execute the DescribeApplicationVersions service
method on AmazonElasticBeanstalk.
The response from the DescribeApplicationVersions service method, as returned by AmazonElasticBeanstalk.
Deletes the specified application along with all associated versions and configurations. NOTE:You cannot delete
an application that has a running environment.
Container for the necessary parameters to execute the DeleteApplication service method on
AmazonElasticBeanstalk.
Updates the specified application version to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Container for the necessary parameters to execute the UpdateApplicationVersion service method
on AmazonElasticBeanstalk.
The response from the UpdateApplicationVersion service method, as returned by AmazonElasticBeanstalk.
Creates an application that has one configuration template named default and no application versions.
NOTE: The default configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6
application container.
Container for the necessary parameters to execute the CreateApplication service method on
AmazonElasticBeanstalk.
The response from the CreateApplication service method, as returned by AmazonElasticBeanstalk.
Container for the necessary parameters to execute the SwapEnvironmentCNAMEs service method on
AmazonElasticBeanstalk.
Updates the specified configuration template to have the specified properties or configuration option values.
NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties,
specify an empty string. Related Topics
- DescribeConfigurationOptions
Container for the necessary parameters to execute the UpdateConfigurationTemplate service
method on AmazonElasticBeanstalk.
The response from the UpdateConfigurationTemplate service method, as returned by AmazonElasticBeanstalk.
Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics
Container for the necessary parameters to execute the RetrieveEnvironmentInfo service method on
AmazonElasticBeanstalk.
The response from the RetrieveEnvironmentInfo service method, as returned by AmazonElasticBeanstalk.
Returns a list of the available solution stack names.
Container for the necessary parameters to execute the ListAvailableSolutionStacks service
method on AmazonElasticBeanstalk.
The response from the ListAvailableSolutionStacks service method, as returned by AmazonElasticBeanstalk.
Updates the specified application to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Container for the necessary parameters to execute the UpdateApplication service method on
AmazonElasticBeanstalk.
The response from the UpdateApplication service method, as returned by AmazonElasticBeanstalk.
Returns descriptions for existing environments.
Container for the necessary parameters to execute the DescribeEnvironments service method on
AmazonElasticBeanstalk.
The response from the DescribeEnvironments service method, as returned by AmazonElasticBeanstalk.
Returns AWS resources for this environment.
Container for the necessary parameters to execute the DescribeEnvironmentResources service
method on AmazonElasticBeanstalk.
The response from the DescribeEnvironmentResources service method, as returned by AmazonElasticBeanstalk.
Terminates the specified environment.
Container for the necessary parameters to execute the TerminateEnvironment service method on
AmazonElasticBeanstalk.
The response from the TerminateEnvironment service method, as returned by AmazonElasticBeanstalk.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are
valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option
values.
Container for the necessary parameters to execute the ValidateConfigurationSettings
service method on AmazonElasticBeanstalk.
The response from the ValidateConfigurationSettings service method, as returned by AmazonElasticBeanstalk.
Causes the environment to restart the application container server running on each Amazon EC2 instance.
Container for the necessary parameters to execute the RestartAppServer service method on
AmazonElasticBeanstalk.
Deletes the draft configuration associated with the running environment. Updating a running environment with any
configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the
update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in
process or has failed. The draft configuration remains in existence until it is deleted with this action.
Container for the necessary parameters to execute the DeleteEnvironmentConfiguration
service method on AmazonElasticBeanstalk.
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new
configuration template, or updates select configuration option values in the running environment. Attempting to update both
the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and
DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
Container for the necessary parameters to execute the UpdateEnvironment service method on
AmazonElasticBeanstalk.
The response from the UpdateEnvironment service method, as returned by AmazonElasticBeanstalk.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of
the application with the same configuration settings. Related Topics
- DescribeConfigurationOptions
- DescribeConfigurationSettings
- ListAvailableSolutionStacks
Container for the necessary parameters to execute the CreateConfigurationTemplate service
method on AmazonElasticBeanstalk.
The response from the CreateConfigurationTemplate service method, as returned by AmazonElasticBeanstalk.
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the
configuration set associated with a running environment. When describing the settings for the configuration set associated
with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other
is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related
Topics
- DeleteEnvironmentConfiguration
Container for the necessary parameters to execute the DescribeConfigurationSettings
service method on AmazonElasticBeanstalk.
The response from the DescribeConfigurationSettings service method, as returned by AmazonElasticBeanstalk.
Returns the descriptions of existing applications.
Container for the necessary parameters to execute the DescribeApplications service method on
AmazonElasticBeanstalk.
The response from the DescribeApplications service method, as returned by AmazonElasticBeanstalk.
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment
and forces a restart.
Container for the necessary parameters to execute the RebuildEnvironment service method on
AmazonElasticBeanstalk.
Returns list of event descriptions matching criteria up to the last 6 weeks. NOTE: This action returns the most
recent 1,000 events from the specified NextToken.
Container for the necessary parameters to execute the DescribeEvents service method on
AmazonElasticBeanstalk.
The response from the DescribeEvents service method, as returned by AmazonElasticBeanstalk.
Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an
AmazonElasticBeanstalkClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonElasticBeanstalkClient Configuration Object
Checks if the specified CNAME is available.
Container for the necessary parameters to execute the CheckDNSAvailability service method on
AmazonElasticBeanstalk.
The response from the CheckDNSAvailability service method, as returned by AmazonElasticBeanstalk.
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution
stack defines. The description includes the values the options, their default values, and an indication of the required action on a running
environment if an option value is changed.
Container for the necessary parameters to execute the DescribeConfigurationOptions service
method on AmazonElasticBeanstalk.
The response from the DescribeConfigurationOptions service method, as returned by AmazonElasticBeanstalk.
Deletes the specified configuration template. NOTE:When you launch an environment using a configuration template,
the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running
environment.
Container for the necessary parameters to execute the DeleteConfigurationTemplate service
method on AmazonElasticBeanstalk.
Launches an environment for the specified application using the specified configuration.
Container for the necessary parameters to execute the CreateEnvironment service method on
AmazonElasticBeanstalk.
The response from the CreateEnvironment service method, as returned by AmazonElasticBeanstalk.
Creates the Amazon S3 storage location for the account. This location is used to store user log files.
Container for the necessary parameters to execute the CreateStorageLocation service method on
AmazonElasticBeanstalk.
The response from the CreateStorageLocation service method, as returned by AmazonElasticBeanstalk.
Initiates a request to compile the specified type of information of the deployed environment. Setting the
InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your
environment. Use RetrieveEnvironmentInfo to access the compiled information. Related Topics
Container for the necessary parameters to execute the RequestEnvironmentInfo service method on
AmazonElasticBeanstalk.
Creates an application version for the specified application. NOTE:Once you create an application version with a
specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an
exception when you attempt to launch an environment from the application version.
Container for the necessary parameters to execute the CreateApplicationVersion service method
on AmazonElasticBeanstalk.
The response from the CreateApplicationVersion service method, as returned by AmazonElasticBeanstalk.
Deletes the specified version from the specified application. NOTE:You cannot delete an application version that
is associated with a running environment.
Container for the necessary parameters to execute the DeleteApplicationVersion service method
on AmazonElasticBeanstalk.
Returns descriptions for existing application versions.
Container for the necessary parameters to execute the DescribeApplicationVersions service
method on AmazonElasticBeanstalk.
The response from the DescribeApplicationVersions service method, as returned by AmazonElasticBeanstalk.
Deletes the specified application along with all associated versions and configurations. NOTE:You cannot delete
an application that has a running environment.
Container for the necessary parameters to execute the DeleteApplication service method on
AmazonElasticBeanstalk.
Updates the specified application version to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Container for the necessary parameters to execute the UpdateApplicationVersion service method
on AmazonElasticBeanstalk.
The response from the UpdateApplicationVersion service method, as returned by AmazonElasticBeanstalk.
Creates an application that has one configuration template named default and no application versions.
NOTE: The default configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6
application container.
Container for the necessary parameters to execute the CreateApplication service method on
AmazonElasticBeanstalk.
The response from the CreateApplication service method, as returned by AmazonElasticBeanstalk.
Container for the necessary parameters to execute the SwapEnvironmentCNAMEs service method on
AmazonElasticBeanstalk.
Updates the specified configuration template to have the specified properties or configuration option values.
NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties,
specify an empty string. Related Topics
- DescribeConfigurationOptions
Container for the necessary parameters to execute the UpdateConfigurationTemplate service
method on AmazonElasticBeanstalk.
The response from the UpdateConfigurationTemplate service method, as returned by AmazonElasticBeanstalk.
Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics
Container for the necessary parameters to execute the RetrieveEnvironmentInfo service method on
AmazonElasticBeanstalk.
The response from the RetrieveEnvironmentInfo service method, as returned by AmazonElasticBeanstalk.
Returns a list of the available solution stack names.
Container for the necessary parameters to execute the ListAvailableSolutionStacks service
method on AmazonElasticBeanstalk.
The response from the ListAvailableSolutionStacks service method, as returned by AmazonElasticBeanstalk.
Updates the specified application to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Container for the necessary parameters to execute the UpdateApplication service method on
AmazonElasticBeanstalk.
The response from the UpdateApplication service method, as returned by AmazonElasticBeanstalk.
Returns descriptions for existing environments.
Container for the necessary parameters to execute the DescribeEnvironments service method on
AmazonElasticBeanstalk.
The response from the DescribeEnvironments service method, as returned by AmazonElasticBeanstalk.
Returns AWS resources for this environment.
Container for the necessary parameters to execute the DescribeEnvironmentResources service
method on AmazonElasticBeanstalk.
The response from the DescribeEnvironmentResources service method, as returned by AmazonElasticBeanstalk.
Terminates the specified environment.
Container for the necessary parameters to execute the TerminateEnvironment service method on
AmazonElasticBeanstalk.
The response from the TerminateEnvironment service method, as returned by AmazonElasticBeanstalk.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are
valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option
values.
Container for the necessary parameters to execute the ValidateConfigurationSettings
service method on AmazonElasticBeanstalk.
The response from the ValidateConfigurationSettings service method, as returned by AmazonElasticBeanstalk.
Causes the environment to restart the application container server running on each Amazon EC2 instance.
Container for the necessary parameters to execute the RestartAppServer service method on
AmazonElasticBeanstalk.
Deletes the draft configuration associated with the running environment. Updating a running environment with any
configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the
update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in
process or has failed. The draft configuration remains in existence until it is deleted with this action.
Container for the necessary parameters to execute the DeleteEnvironmentConfiguration
service method on AmazonElasticBeanstalk.
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new
configuration template, or updates select configuration option values in the running environment. Attempting to update both
the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and
DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
Container for the necessary parameters to execute the UpdateEnvironment service method on
AmazonElasticBeanstalk.
The response from the UpdateEnvironment service method, as returned by AmazonElasticBeanstalk.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of
the application with the same configuration settings. Related Topics
- DescribeConfigurationOptions
- DescribeConfigurationSettings
- ListAvailableSolutionStacks
Container for the necessary parameters to execute the CreateConfigurationTemplate service
method on AmazonElasticBeanstalk.
The response from the CreateConfigurationTemplate service method, as returned by AmazonElasticBeanstalk.
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the
configuration set associated with a running environment. When describing the settings for the configuration set associated
with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other
is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related
Topics
- DeleteEnvironmentConfiguration
Container for the necessary parameters to execute the DescribeConfigurationSettings
service method on AmazonElasticBeanstalk.
The response from the DescribeConfigurationSettings service method, as returned by AmazonElasticBeanstalk.
Returns the descriptions of existing applications.
Container for the necessary parameters to execute the DescribeApplications service method on
AmazonElasticBeanstalk.
The response from the DescribeApplications service method, as returned by AmazonElasticBeanstalk.
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment
and forces a restart.
Container for the necessary parameters to execute the RebuildEnvironment service method on
AmazonElasticBeanstalk.
Returns list of event descriptions matching criteria up to the last 6 weeks. NOTE: This action returns the most
recent 1,000 events from the specified NextToken.
Container for the necessary parameters to execute the DescribeEvents service method on
AmazonElasticBeanstalk.
The response from the DescribeEvents service method, as returned by AmazonElasticBeanstalk.
Security group and user ID pair.
Sets the UserId property
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the GroupId property
AWS Group ID of a Security Group. Cannot be used when
specifying a CIDR IP address.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
Name of the security group. Cannot be used when
specifying a CIDR IP address.
this instance
Checks if GroupName property is set
true if GroupName property is set
Gets and sets the UserId property.
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
Gets and sets the GroupId property.
AWS Group ID of a Security Group. Cannot be used when
specifying a CIDR IP address.
Gets and sets the GroupName property.
Name of the security group. Cannot be used when
specifying a CIDR IP address.
Result of a StopInstances request.
Checks if StoppingInstances property is set
true if StoppingInstances property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the StoppingInstances property.
Snapshot Attribute
Sets the SnapshotId property
The ID of the Amazon EBS snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the CreateVolumePermission property
list of create volume permissions
this instance
Checks if CreateVolumePermission property is set
true if CreateVolumePermission property is set
Gets and sets the SnapshotId property.
The ID of the Amazon EBS snapshot.
Gets and sets the CreateVolumePermission property.
list of create volume permissions
Security Group
Sets the OwnerId property
AWS Access Key ID of the owner of the security
group.
this instance
Checks if OwnerId property is set
true if OwnerId property is set
Sets the VpcId property
The vpc to which the group belongs.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the GroupId property
Id of the security group.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
Name of the security group.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the GroupDescription property
Description of the security group.
this instance
Checks if GroupDescription property is set
true if GroupDescription property is set
Sets the Tag property
A list of tags for the security group.
this instance
Checks if Tag property is set
true if Tag property is set
Sets the IpPermission property
Set of IP permissions associated with the
security group.
this instance
Checks if IpPermission property is set
true if IpPermission property is set
Sets the IpPermissionsEgress property
A list of outbound rules associated with the security group (for VPC security groups).
this instance
Checks if IpPermissionsEgress property is set
true if IpPermissionsEgress property is set
Gets and sets the OwnerId property.
AWS Access Key ID of the owner of the security
group.
Gets and sets the VpcId property.
The vpc to which the group belongs.
Gets and sets the GroupId property.
Id of the security group.
Gets and sets the GroupName property.
Name of the security group.
Gets and sets the GroupDescription property.
Description of the security group.
Gets and sets the Tag property.
A list of tags for the security group.
Gets and sets the IpPermission property.
Set of IP permissions associated with the
security group.
Gets and sets the IpPermissionsEgress property.
A list of outbound rules associated with the security group (for VPC security groups).
The Response for the
ReplaceRoute operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Requests a reboot of one or more instances. This operation is
asynchronous; it only queues a request to reboot the specified
instance(s). The operation will succeed if the instances
are valid and belong to you. Requests to reboot terminated instances
are ignored.
Note - if a Linux/UNIX instance does not cleanly shut
down within four
minutes, Amazon EC2 will perform a hard reboot.
Sets the InstanceId property
One or more instance IDs.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
One or more instance IDs.
Modify Image Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Retrieves the encrypted administrator password
for the instances running
Windows.
Note - the Windows password is
only generated the first time an AMI is launched.
It is not generated for rebundled AMIs or after the password is
changed on an instance.
The password is encrypted using the key pair that you
provided.
Sets the InstanceId property
The ID of the instance for which to get the
password.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
The ID of the instance for which to get the
password.
Gives you information about your subnets. You can
filter the results to return information
only about subnets that match criteria you specify. For example, you
could ask to get information about a particular subnet
(or all) only if the subnet's state is available. You
can specify multiple filters (e.g.,
the subnet is in a particular
VPC, and the subnet's state is available).
The result includes information for a particular subnet
only if the subnet matches all your filters. If there's
no match, no special message is returned; the response
is simply empty
Sets the SubnetId property
A subnet ID.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the Filter property
The filter to apply on the results of DescribeSubnets. Filters can be:
a. state - The state of the subnet. (pending, available).
b. vpcId - The ID of the VPC the subnet is in.
c. cidrBlock - The CIDR block of the subnet. The
CIDR block you specify must exactly match the subnet's CIDR block
for information to be returned for the subnet.
Constraints: Must contain the slash followed by one or two
digits (e.g., /28)
d. - The Availability Zone the subnet is in.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the SubnetId property.
A subnet ID.
Gets and sets the Filter property.
The filter to apply on the results of DescribeSubnets. Filters can be:
a. state - The state of the subnet. (pending, available).
b. vpcId - The ID of the VPC the subnet is in.
c. cidrBlock - The CIDR block of the subnet. The
CIDR block you specify must exactly match the subnet's CIDR block
for information to be returned for the subnet.
Constraints: Must contain the slash followed by one or two
digits (e.g., /28)
d. - The Availability Zone the subnet is in.
The Response for the DescribeSpotInstanceRequests
operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSpotInstanceRequestsResult property is set
true if DescribeSpotInstanceRequestsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSpotInstanceRequestsResult property.
The Result of the Describe Spot Instances
operation.
Describe Reserved Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeReservedInstancesResult property is set
true if DescribeReservedInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeReservedInstancesResult property.
Describe Reserved Instances Result
Describe Reserved Instances Offerings Result
Checks if ReservedInstancesOffering property is set
true if ReservedInstancesOffering property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ReservedInstancesOffering property.
list of reserved instances offering
Describe Regions Result
Checks if Region property is set
true if Region property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Region property.
List of regions
DescribeInternetGateways Result
Checks if InternetGateways property is set
true if InternetGateways property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the InternetGateways property.
A list of Internet Gateways.
The Response for the
CreateSpotDatafeedSubscription operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateSpotDatafeedSubscriptionResult property is set
true if CreateSpotDatafeedSubscriptionResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateSpotDatafeedSubscriptionResult property.
Create Spot Datafeed Result
Creates an AMI that uses an Amazon EBS root device from a "running" or
"stopped" instance. AMIs that use an Amazon EBS root device boot
faster than AMIs that use instance stores. They can be up to 1 TiB in size,
use storage that persists on instance failure, and can be stopped
and started.
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Name property
The name of the AMI that was provided during image
creation. Must be 3-128 alphanumeric characters,
parenthesis (()), commas (,), slashes (/), dashes (-), or
underscores(_).
this instance
Checks if Name property is set
true if Name property is set
Sets the Description property
The description of the AMI that was provided
during
image creation. Can be up to 255 characters.
this instance
Checks if Description property is set
true if Description property is set
Sets the NoReboot property
By default this property is set to false, which means
Amazon EC2 attempts to cleanly shut down the
instance before image creation and reboots the instance
afterwards. When set to true, Amazon EC2 does not shut down the
instance before creating the image. When this option is used,
file system integrity on the created image cannot be guaranteed.
Default is FALSE.
this instance
Checks if NoReboot property is set
true if NoReboot property is set
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the Name property.
The name of the AMI that was provided during image
creation. Must be 3-128 alphanumeric characters,
parenthesis (()), commas (,), slashes (/), dashes (-), or
underscores(_).
Gets and sets the Description property.
The description of the AMI that was provided
during
image creation. Can be up to 255 characters.
Gets and sets the NoReboot property.
By default this property is set to false, which means
Amazon EC2 attempts to cleanly shut down the
instance before image creation and reboots the instance
afterwards. When set to true, Amazon EC2 does not shut down the
instance before creating the image. When this option is used,
file system integrity on the created image cannot be guaranteed.
Default is FALSE.
Creates a set of DHCP options that you can then
associate with one or more VPCs, causing all
existing and new instances that you launch in those
VPCs to use the set of DHCP options. The following
table lists the individual DHCP options you
can specify. For more information about the options, go to
RFC
2132.
Options:
1. domain-name
A domain name of your choice (e.g., mydomain.com).
2. domain-name-servers
The IP address of a domain name server (e.g., 10.2.5.1).
You can specify up to four addresses.
3. ntp-servers
The IP address of a Network Time Protocol (NTP)
server (e.g., 10.4.6.1). You can specify up to four addresses.
4.
netbios-name-servers The IP address of a NetBIOS name server (e.g.,
10.8.9.5). You can specify up to four addresses.
5.
netbios-node-type Value indicating the NetBIOS node type (1, 2, 4,
or 8). For more information about the values, go to RFC 2132.
We recommend you only use 2 at this time (broadcast and multicast
are currently not supported)
Sets the DhcpConfiguration property
DHCP Configuration
this instance
Checks if DhcpConfiguration property is set
true if DhcpConfiguration property is set
Gets and sets the DhcpConfiguration property.
DHCP Configuration
Create Customer Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateCustomerGatewayResult property is set
true if CreateCustomerGatewayResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateCustomerGatewayResult property.
Create Customer Gateway Result
The Response for the
AuthorizeSecurityGroupEgress operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action adds one or more egress rules to a VPC security group. Specifically, this permits instances
in a security group to send traffic to either one or more destination CIDR IP address ranges, or to one or
more destination security groups in the same VPC.
Each rule consists of the protocol (e.g., TCP), plus either a CIDR range, or a source group. For the TCP
and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you
must also specify the ICMP type and code.You can use -1 as a wildcard for the ICMP type or code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Sets the GroupId property
ID of the VPC security group to modify.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the IpPermissions property
Set of IP permissions associated with the
security group.
this instance
Checks if IpPermissions property is set
true if IpPermissions property is set
Gets and sets the GroupId property.
ID of the VPC security group to modify.
Gets and sets the IpPermissions property.
Set of IP permissions associated with the
security group.
Attach Vpn Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if AttachVpnGatewayResult property is set
true if AttachVpnGatewayResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the AttachVpnGatewayResult property.
Attach VpnGateway Result
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For
more information about your VPC and Internet gateway, go to the Amazon Virtual Private Cloud User
Guide.
Sets the InternetGatewayId property
The ID of the Internet gateway to attach.
this instance
Checks if InternetGatewayId property is set
true if InternetGatewayId property is set
Sets the VpcId property
The ID of the VPC.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the InternetGatewayId property.
The ID of the Internet gateway to attach.
Gets and sets the VpcId property.
The ID of the VPC.
DescribeAlarmsResult Unmarshaller
Delete Alarms Request Marshaller
The MetricAlarm data type represents an alarm. You can use
PutMetricAlarm to create or update an alarm.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the AlarmArn property
The value to set for the AlarmArn property
this instance
Sets the AlarmDescription property
The value to set for the AlarmDescription property
this instance
Sets the AlarmConfigurationUpdatedTimestamp property
The value to set for the AlarmConfigurationUpdatedTimestamp property
this instance
Sets the ActionsEnabled property
The value to set for the ActionsEnabled property
this instance
Adds elements to the OKActions collection
The values to add to the OKActions collection
this instance
Adds elements to the OKActions collection
The values to add to the OKActions collection
this instance
Adds elements to the AlarmActions collection
The values to add to the AlarmActions collection
this instance
Adds elements to the AlarmActions collection
The values to add to the AlarmActions collection
this instance
Adds elements to the InsufficientDataActions collection
The values to add to the InsufficientDataActions collection
this instance
Adds elements to the InsufficientDataActions collection
The values to add to the InsufficientDataActions collection
this instance
Sets the StateValue property
The value to set for the StateValue property
this instance
Sets the StateReason property
The value to set for the StateReason property
this instance
Sets the StateReasonData property
The value to set for the StateReasonData property
this instance
Sets the StateUpdatedTimestamp property
The value to set for the StateUpdatedTimestamp property
this instance
Sets the MetricName property
The value to set for the MetricName property
this instance
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the Statistic property
The value to set for the Statistic property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the Period property
The value to set for the Period property
this instance
Sets the Unit property
The value to set for the Unit property
this instance
Sets the EvaluationPeriods property
The value to set for the EvaluationPeriods property
this instance
Sets the Threshold property
The value to set for the Threshold property
this instance
Sets the ComparisonOperator property
The value to set for the ComparisonOperator property
this instance
The name of the alarm.
Constraints:
-
Length
1 - 255
The Amazon Resource Name (ARN) of the alarm.
Constraints:
-
Length
1 - 1600
The description for the alarm.
Constraints:
-
Length
0 - 255
The time stamp of the last update to the alarm configuration.
Indicates whether actions should be executed during any changes to the alarm's state.
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.
Constraints:
-
Length
0 - 5
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.
Constraints:
-
Length
0 - 5
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an
Auto Scaling policy.
Constraints:
-
Length
0 - 5
The state value for the alarm.
Constraints:
-
Allowed Values
OK, ALARM, INSUFFICIENT_DATA
A human-readable explanation for the alarm's state.
Constraints:
-
Length
0 - 1023
An explanation for the alarm's state in machine-readable JSON format
Constraints:
-
Length
0 - 4000
The time stamp of the last update to the alarm's state.
The name of the alarm's metric.
Constraints:
-
Length
1 - 255
The namespace of alarm's associated metric.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The statistic to apply to the alarm's associated metric.
Constraints:
-
Allowed Values
SampleCount, Average, Sum, Minimum, Maximum
The list of dimensions associated with the alarm's associated metric.
Constraints:
-
Length
0 - 10
The period in seconds over which the statistic is applied.
Constraints:
-
Range
60 -
The unit of the alarm's associated metric.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
The number of periods over which data is compared to the specified threshold.
Constraints:
-
Range
1 -
The value against which the specified statistic is compared.
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is
used as the first operand.
Constraints:
-
Allowed Values
GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
Returns information about the DisableAlarmActions response metadata.
The DisableAlarmActions operation has a void result type.
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.
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
The names of the alarms to disable actions for.
Constraints:
-
Length
0 - 100
The output for the DescribeAlarms action.
Adds elements to the MetricAlarms collection
The values to add to the MetricAlarms collection
this instance
Adds elements to the MetricAlarms collection
The values to add to the MetricAlarms collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of information for the specified alarms.
A string that marks the start of the next batch of returned results.
The AlarmHistoryItem data type contains descriptive
information about the history of a specific alarm. If you call
DescribeAlarmHistory, Amazon CloudWatch returns this data type as part
of the DescribeAlarmHistoryResult data type.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the HistoryItemType property
The value to set for the HistoryItemType property
this instance
Sets the HistorySummary property
The value to set for the HistorySummary property
this instance
Sets the HistoryData property
The value to set for the HistoryData property
this instance
The descriptive name for the alarm.
Constraints:
-
Length
1 - 255
The time stamp for the alarm history item.
The type of alarm history item.
Constraints:
-
Allowed Values
ConfigurationUpdate, StateUpdate, Action
A human-readable summary of the alarm history.
Constraints:
-
Length
1 - 255
Machine-readable data about the alarm in JSON format.
Constraints:
-
Length
1 - 4095
Interface for accessing AmazonCloudWatch.
Amazon CloudWatch Amazon CloudWatch is a web service that
enables you to monitor and manage various metrics, as well as
configure alarm actions based on data from metrics.
Amazon CloudWatch monitoring enables you to collect, analyze,
and view system and application metrics so that you can make
operational and business decisions more quickly and with greater
confidence. You can use Amazon CloudWatch to collect metrics about
your AWS resources, such as the performance of your Amazon EC2
instances. You can also publish your own metrics directly to Amazon
CloudWatch. Amazon CloudWatch allows you to manage the
metrics in several ways. If you are publishing your own metrics, you
can define custom metrics for your own use. If you are registered for
an AWS product that supports Amazon CloudWatch, the service
automatically pushes basic metrics to CloudWatch for you. Once Amazon
CloudWatch contains metrics from either source, you can calculate
statistics based on that data and graphically visualize those
statistics in the Amazon CloudWatch Console. Amazon
CloudWatch alarms help you implement decisions more easily by enabling
you to do things like send notifications or automatically make changes
to the resources you are monitoring, based on rules that you define.
For example, you can create alarms that initiate Auto Scaling and
Simple Notification Service actions on your behalf.
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. When this operation creates an alarm,
the alarm state is immediately set to INSUFFICIENT_DATA . The
alarm is evaluated and its StateValue is set appropriately.
Any actions associated with the StateValue is then executed.
NOTE: When updating an existing alarm, its
StateValue is left unchanged.
Container for the necessary
parameters to execute the PutMetricAlarm service method on
AmazonCloudWatch.
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. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action. The size of
a PutMetricData request is limited to 8 KB for HTTP GET requests and
40 KB for HTTP POST requests. IMPORTANT: Although
the Value parameter accepts numbers of type Double, Amazon CloudWatch
truncates values with very large exponents. Values with base-10
exponents greater than 126 (1 x 10^126) are truncated. Likewise,
values with base-10 exponents less than -130 (1 x 10^-130) are also
truncated.
Container for the necessary
parameters to execute the PutMetricData service method on
AmazonCloudWatch.
Returns a list of valid metrics stored for the AWS account
owner. Returned metrics can be used with GetMetricStatistics to
obtain statistical data for a given metric. NOTE:
Up to 500 results are returned for any one call. To retrieve further
results, use returned NextToken values with subsequent ListMetrics
operations. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action.
Container for the necessary
parameters to execute the ListMetrics service method on
AmazonCloudWatch.
The response from the ListMetrics service method, as returned
by AmazonCloudWatch.
Gets statistics for the specified metric.
NOTE: The maximum number of data points returned from a
single GetMetricStatistics request is 1,440. If a request is made that
generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified
time range or increasing the specified period. Alternatively, make
multiple requests across adjacent time ranges. Amazon
CloudWatch aggregates data points based on the length of the
period 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. NOTE: The maximum number of data
points that can be queried is 50,850; whereas the maximum number of
data points returned is 1,440. The following examples
show various statistics allowed by the data point query maximum of
50,850 when you call GetMetricStatistics on Amazon EC2
instances with detailed (one-minute) monitoring enabled:
- Statistics for up to 400 instances for a span of one hour
- Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
Container for the necessary
parameters to execute the GetMetricStatistics service method on
AmazonCloudWatch.
The response from the GetMetricStatistics service method, as
returned by AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DisableAlarmActions service method on
AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DescribeAlarms service method on
AmazonCloudWatch.
The response from the DescribeAlarms service method, as
returned by AmazonCloudWatch.
Retrieves all alarms for a single metric. Specify a statistic,
period, or unit to filter the set of alarms further.
Container for the
necessary parameters to execute the DescribeAlarmsForMetric service
method on AmazonCloudWatch.
The response from the DescribeAlarmsForMetric service method,
as returned by AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DescribeAlarmHistory service method on
AmazonCloudWatch.
The response from the DescribeAlarmHistory service method, as
returned by AmazonCloudWatch.
Enables actions for the specified alarms.
Container for the necessary
parameters to execute the EnableAlarmActions service method on
AmazonCloudWatch.
Deletes all specified alarms. In the event of an error, no
alarms are deleted.
Container for the necessary
parameters to execute the DeleteAlarms service method on
AmazonCloudWatch.
Temporarily sets the state of an alarm. When the updated
StateValue differs from the previous value, the action
configured for the appropriate state is invoked. This is not a
permanent change. The next periodic alarm check (in about a minute)
will set the alarm to its actual state.
Container for the necessary
parameters to execute the SetAlarmState service method on
AmazonCloudWatch.
The GetOriginAccessIdentityConfigRequest contains the parameters used for the GetOriginAccessIdentityConfig operation.
Required Parameters: Id
Base class for CloudFront operation requests.
Provides a header collection which can is used to store the request headers.
Base class for Cloudfront operations that provides headers.
The protected member that holds the service specific headers with which
the HTTP Request is configured.
This is used by all derived Requests
Checks if Headers property is set
true if Headers property is set
Adds all of the key/value pairs from collection into our request header.
A collection of key/value headers
Gets the Headers property.
The ID of the CloudFront distribution
- Get Distribution Config
- Get Distribution Info
- Set Distribution Config
- Delete Distribution
The ETag for the distribution.
This value is returned by the CloudFront
service when:
- a distribution is created
- a distribution's info is requested
- a distribution's config is requested
- a distribution's config is modified
The CloudFront Distribution Config object used by:
- Set Distribution Config
- Create Distribution
The CloudFront Streaming Distribution Config object used by:
- Set Streaming Distribution Config
- Create Streaming Distribution
All keys returned will be lexiographically after the marker.
Used by ListDistributionsRequest
Limits the result set of keys to MaxItems.
Used by ListDistributionsRequest
Checks if Id property is set.
true if Id property is set.
Checks if ETag property is set.
true if ETag property is set.
Checks if DistributionConfig property is set.
true if DistributionConfig property is set.
Checks if StreamingDistributionConfig property is set.
true if StreamingDistributionConfig property is set.
Checks if Marker property is set
true if Marker property is set
Checks if MaxItems property is set
true if MaxItems property is set
Gets and sets the Id property.
Gets and sets the ETag property.
Gets and Sets the DistributionConfig property.
Gets and Sets the StreamingDistributionConfig property.
Gets and sets the Marker property.
Gets and sets the MaxItems property.
Sets the Id property of this request to the value passed in.
The OriginAccessIdentity's id
The request with the Id property set
Gets and sets the Id property for the Origin Access Identity
Response Unmarshaller for CreateStack operation
The StackResourceSummary data type.
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
Sets the PhysicalResourceId property
The value to set for the PhysicalResourceId property
this instance
Sets the ResourceType property
The value to set for the ResourceType property
this instance
Sets the LastUpdatedTimestamp property
The value to set for the LastUpdatedTimestamp property
this instance
Sets the ResourceStatus property
The value to set for the ResourceStatus property
this instance
Sets the ResourceStatusReason property
The value to set for the ResourceStatusReason property
this instance
The logical name of the resource specified in the template.
The name or unique identifier that corresponds to a physical instance ID of the resource.
Type of the resource. (For more information, go to the AWS
CloudFormation User Guide.)
Time the status was updated.
Current status of the resource.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
Success/failure message associated with the resource.
Returns information about the DescribeStackResourcesResult response and response metadata.
Gets and sets the DescribeStackResourcesResult property.
The output for a DescribeStackResources action.
Returns information about the DescribeStackEventsResult response and response metadata.
Gets and sets the DescribeStackEventsResult property.
The output for a DescribeStackEvents action.
Returns information about the DeleteStack response metadata.
The DeleteStack operation has a void result type.
AmazonCloudFormation exception
Constructs a new AlreadyExistsException with the specified error
message.
Describes the error encountered.
Response Unmarshaller for ResumeProcesses operation
Resume Processes Request Marshaller
NotificationConfiguration Unmarshaller
The MetricGranularityType data type.
Sets the Granularity property
The value to set for the Granularity property
this instance
The granularity of a Metric.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the DisableMetricsCollection operation.
Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of
affected metrics with the Metrics parameter.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
The name or ARN of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported:
- GroupMinSize
- GroupMaxSize
- GroupDesiredCapacity
- GroupInServiceInstances
- GroupPendingInstances
- GroupTerminatingInstances
- GroupTotalInstances
A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.
Adds elements to the ScheduledUpdateGroupActions collection
The values to add to the ScheduledUpdateGroupActions collection
this instance
Adds elements to the ScheduledUpdateGroupActions collection
The values to add to the ScheduledUpdateGroupActions collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of scheduled actions designed to update an Auto Scaling group.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The output of the DescribeScalingProcessTypes action.
Adds elements to the Processes collection
The values to add to the Processes collection
this instance
Adds elements to the Processes collection
The values to add to the Processes collection
this instance
A list of ProcessType names.
Returns information about the DescribeScalingActivitiesResult response and response metadata.
Gets and sets the DescribeScalingActivitiesResult property.
The output for the DescribeScalingActivities action.
Adds elements to the AutoScalingNotificationTypes collection
The values to add to the AutoScalingNotificationTypes collection
this instance
Adds elements to the AutoScalingNotificationTypes collection
The values to add to the AutoScalingNotificationTypes collection
this instance
Eric's doc mentions the following: autoscaling:EC2_Instance_Launch, autoscaling:EC2_Instance_Terminate, autoscaling:Error. Should we list
them? Where can I get a complete list to add here or refer users to?>
Container for the parameters to the DescribeAutoScalingNotificationTypes operation.
Returns a list of all notification types that are supported by Auto Scaling. What if the input is empty?
An access control policy action identifies a specific action in a service
that can be performed on a resource. For example, sending a message to a
queue.
ActionIdentifiers allow you to limit what your access control policy statement affects.
For example, you could create a policy statement that enables a certain group
of users to send messages to your queue, but not allow them to perform any
other actions on your queue.
The action is B in the statement
"A has permission to do B to C where D applies."
Free form access control policy actions may include a wildcard (*) to match
multiple actions.
Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace.
Constructs an Actionidentifer with the given action name.
The name of the action
Gets and sets the name of this action. For example, 'sqs:SendMessage' is the
name corresponding to the SQS action that enables users to send a message
to an SQS queue.
A
Returns a list of messages and metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Information about the request provided by Amazon SQS.
Sets the RequestId property
A unique ID for tracking the request.
this instance
Checks if RequestId property is set
true if RequestId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the RequestId property.
A unique ID for tracking the request.
Encapsulates the result of the ListSubscriptions action.
Checks if Subscriptions property is set
true if Subscriptions property is set
Checks if NextToken property is set
true if NextToken property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Subscriptions property.
A list of subscriptions.
Gets and sets the NextToken property.
A token sent to an endpoint during the Subscribe operation.
Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
Delete Verified Email Address Request Marshaller
The PutAttributes operation creates or replaces attributes in an item. Attributes are uniquely identified in an
item by their name/value combination. For example, a single item can have the attributes { "first_name",
"first_value" } and { "first_name", second_value" }. However, it cannot have two attribute instances where both
the attribute name and attribute value are the same.
Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to
true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the
attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes
{ 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' }
and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.
Note: Using PutAttributes to replace attribute values that do not exist will not result in an error response.
You cannot specify an empty string as an attribute name. Because Amazon SimpleDB makes multiple copies of your data
and uses an eventual consistency update model, an immediate GetAttributes or Select request (read) immediately after a
DeleteAttributes request (write) might not return the updated data.
The following limitations are enforced for this operation:
* 256 total attribute name-value pairs per item
* One billion attributes per domain
* 10 GB of total user data storage per domain
Sets the DomainName property
The name of the domain in which to perform the operation.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the ItemName property
The name of the item.
this instance
Checks if ItemName property is set
true if ItemName property is set
Sets the Attribute property
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
this instance
Checks if Attribute property is set
true if Attribute property is set
Sets the Expected property
Performs the operation if the specified attribute name and value match.
this instance
Checks if Expected property is set
true if Expected property is set
Gets and sets the DomainName property.
The name of the domain in which to perform the operation.
Gets and sets the ItemName property.
The name of the item.
Gets and sets the Attribute property.
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
Gets and sets the Expected property.
Performs the operation if the specified attribute name and value match.
Lists all domains associated with the account. It returns domain names up to the limit set by MaxNumberOfDomains.
A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times
with the NextToken returns up to MaxNumberOfDomains more domain names each time.
Sets the ListDomainsResult property
Lists all domains associated with the account. It returns domain names up to the limit set by MaxNumberOfDomains.
A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times
with the NextToken returns up to MaxNumberOfDomains more domain names each time.
this instance
Checks if ListDomainsResult property is set
true if ListDomainsResult property is set
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ListDomainsResult property.
Lists all domains associated with the account. It returns domain names up to the limit set by MaxNumberOfDomains.
A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times
with the NextToken returns up to MaxNumberOfDomains more domain names each time.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Deletes one or more attributes associated with the item. If all attributes of an item are deleted, the
item is deleted.
Sets the DomainName property
The name of the domain in which to perform the operation.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the ItemName property
The name of the item in which to perform the operation.
this instance
Checks if ItemName property is set
true if ItemName property is set
Sets the Attribute property
List of attributes to delete.
this instance
Checks if Attribute property is set
true if Attribute property is set
Sets the Expected property
Performs the operation if the specified attribute name and value match.
this instance
Checks if Expected property is set
true if Expected property is set
Gets and sets the DomainName property.
The name of the domain in which to perform the operation.
Gets and sets the ItemName property.
The name of the item in which to perform the operation.
Gets and sets the Attribute property.
List of attributes to delete.
Gets and sets the Expected property.
Performs the operation if the specified attribute name and value match.
The UploadPartRequest contains the parameters used for the UploadPart method.
If PartSize is not specified then the rest of the content from the file
or stream will be sent to Amazon S3.
You must set either the FilePath or InputStream. If FilePath is set then the FilePosition
property must be set.
Required Parameters: BucketName, Key, UploadId, PartNumber
Sets the BucketName property for this request.
This is the S3 Bucket where the S3 Object you are
creating gets put.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you create.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the UploadId property for this request.
This is the upload id for the multipart upload in process.
The value that UploadId is set to
the request with the UploadId set
Checks if UploadId property is set.
true if UploadId property is set.
Sets the PartNumber property for this request.
The value that PartNumber is set to
the request with the PartNumber set
Checks if PartNumber property is set.
true if PartNumber property is set.
Sets the PartSize property for this request.
The value that PartSize is set to
the request with the PartSize set
Checks if PartSize property is set.
true if PartSize property is set.
Sets the MD5Digest property for this request.
The value that Md5Digest is set to
the request with the Md5Digest set
Checks if Md5Digest property is set.
true if Md5Digest property is set.
Sets the GenerateMD5Digest property. If this property is set,
the MD5 md5Digest of the part to be uploaded is generated
prior to the data being sent to S3.
GenerateMD5Digest property
this instance
This is a computationally expensive operation,
and will add to the total time it will take to upload
data to S3. Please use this option judicially.
Sets the FilePath property for this request.
The value that FilePath is set to
the request with the FilePath set
Checks if FilePath property is set.
true if FilePath property is set.
Sets the FilePosition property for this request.
The value that FilePosition is set to
the request with the FilePosition set
Checks if FilePosition property is set.
true if FilePosition property is set.
Sets the Timeout property (in milliseconds).
Please set the timeout only if you are certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
Timeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
ReadWriteTimeout property
A value less than or equal to 0 will be silently ignored
this instance
The "handler" will be notified every time a put
object progress event is raised.
A method that consumes the put object progress notification
this instance of the PutObjectRequest
This method is called by a producer of put object progress
notifications. When called, all the subscribers in the
invocation list will be called sequentially.
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the UploadId property.
This is the upload id for the multipart upload in process.
Gets and sets the PartNumber property.
Gets and sets the PartSize property.
Gets and sets the MD5Digest property.
Gets and Sets the property that governs whether
a md5Digest is generated for the part being
PUT into S3.
Gets and sets the FilePath property.
Gets and sets the FilePosition property. This field is required when
a file path is specified. It is ignored when using the InputStream property.
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for S3 PUT Object requests.
A value less than or equal to 0 will be silently ignored
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout properties of the
HTTPWebRequest object used for S3 PUT Object requests.
A value less than or equal to 0 will be silently ignored
The event for Put Object progress notifications. All
subscribers will be notified when a new progress
event is raised.
Subscribe to this event if you want to receive
put object progress notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, PutObjectProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the Put Object Progress Event delegate's invocation list
PutObjectRequest request = new PutObjectRequest();
request.PutObjectProgressEvent += displayProgress;
Encapsulates the information needed to provide
transfer progress to subscribers of the Put Object
Event.
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
Returns a string representation of this object
Gets the percentage of transfer completed
Gets the number of bytes transferred since last event
Gets the number of bytes transferred
Gets the total number of bytes to be transferred
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
The PutObjectRequest contains the parameters used for the PutObject operation.
Must set only 1 of ContentBody, InputStream, or FilePath
Required Parameters: BucketName, Key
Optional Parameters: CannedACL, ACL, MD5Digest, GenerateMD5Digest,
ContentType, Metadata, Timeout
The "handler" will be notified every time a put
object progress event is raised.
A method that consumes the put object progress notification
this instance of the PutObjectRequest
Sets the BucketName property for this request.
This is the S3 Bucket where the S3 Object you are
creating gets put.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you create.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the FilePath property for this request.
If this is set the request will upload the
specified file to S3. Provide FilePath as an
absolute path.
The value that FilePath is set to
the request with the FilePath set
Checks if FilePath property is set.
true if FilePath property is set.
Sets the CannedACL property for this request.
If set, the S3 Object will have this CannedACL
permission. Please refer to
for
information on S3 Canned ACLs.
The Canned ACL to be set on the object
The request with the CannedACL set
Checks if the CannedACL property is set.
true if there is the CannedACL property is set.
Resets the CannedACL
Sets the MD5Digest property. This is the MD5 Hash of the file.
If supplied, after the file has been uploaded to S3,
S3 checks to ensure that the MD5 hash of the uploaded file
matches the hash supplied.
MD5Digest property
this instance
Checks if MD5Digest property is set.
true if MD5Digest property is set.
Sets the GenerateMD5Digest property. If this property is set,
the MD5 md5Digest of the data to be uploaded is generated
prior to the data being sent to S3.
GenerateMD5Digest property
this instance
This is a computationally expensive operation,
and will add to the total time it will take to upload
data to S3. Please use this option judicially.
Sets the ContentType property for this request.
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
the value the ContentType to be set to
The request with the ContentType set
Checks if ContentType property is set.
true if ContentType property is set.
Sets the ContentBody property for this request.
Use this property if you want to upload plaintext to
S3. The ContentBody is the data for your S3 Object.
the value the ContentBody to be set to
The request with the ContentBody set
Checks if ContentBody property is set.
true if ContentBody property is set.
Adds a key/value pair to the Metadata property for this request.
The S3 Object that you create will have this metadata associated
with it.
The key to associate with the object
The value for the key
The response with Metadata set.
Adds a set of key-value pairs to the request
The set of key-value pairs that will eventually be
associated with the S3 Object
Checks if Metadata property is set.
true if Metadata property is set.
Removes a key from the Metadata list if it was
added previously
The key to remove
Sets the Timeout property (in milliseconds).
Please set the timeout only if you are certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
Timeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
ReadWriteTimeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the StorageClass property for this request.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
for
information on S3 Storage Classes.
The Storage Class to be set on the object
The request with the StorageClass set
This method is called by a producer of put object progress
notifications. When called, all the subscribers in the
invocation list will be called sequentially.
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
Sets the AutoCloseStream property for this request. If this value is set to true
then the stream used with this request will be closed when all the content
is read from the stream. The property is defaulted to true.
the value the AutoCloseStream to be set to
The request with the AutoCloseStream set
The event for Put Object progress notifications. All
subscribers will be notified when a new progress
event is raised.
Subscribe to this event if you want to receive
put object progress notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, PutObjectProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the Put Object Progress Event delegate's invocation list
PutObjectRequest request = new PutObjectRequest();
request.PutObjectProgressEvent += displayProgress;
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the FilePath property.
Gets and sets the CannedACL property.
If set, the S3 Object will have this CannedACL
permission. Please refer to
for
information on S3 Canned ACLs.
Gets and sets the MD5 Digest property.
The base64 encoded 128-bit MD5 digest of the message
(without the headers) according to RFC 1864. This header
can be used as a message integrity check to verify that
the data is the same data that was originally sent.
Although it is optional, we recommend using the
Content-MD5 mechanism as an end-to-end integrity check.
Gets and Sets the property that governs whether
a md5Digest is generated for the object being
PUT into S3.
Gets and sets the ContentType property.
Gets and sets the ContentBody property.
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for S3 PUT Object requests.
A value less than or equal to 0 will be silently ignored
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout properties of the
HTTPWebRequest object used for S3 PUT Object requests.
A value less than or equal to 0 will be silently ignored
Gets and sets the StorageClass property.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
for
information on S3 Storage Classes.
Gets and sets the AutoCloseStream property. If this value is set to true
then the stream used with this request will be closed when all the content
is read from the stream. The property is defaulted to true.
Encapsulates the information needed to provide
transfer progress to subscribers of the Put Object
Event.
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
The ListBucketsRequest contains the parameters used for the ListBuckets operation.
No parameters are needed for this request.
Creates a Key Value pair relating the key and value of type
T and U respectively
The type of the key
The type of the value
The default constructor
Constructs a Tuple relating an instance
of type T to an instance of type U
The key
The value
Returns the hash code for this tuple
A 32-bit signed integer hash code
Determines whether two Tuple objects have the same value.
true if obj is a String and its value is the same as this instance; otherwise, false.
Determines whether two Tuple objects have the same value.
true if obj is a String and its value is the same as this instance; otherwise, false.
Returns the key of this Tuple
Returns the value of this Tuple
The DeleteObjectRequest contains the parameters used for the DeleteObject operation.
Required Parameters: BucketName, Key
The MfaCodes property is required if the bucket containing this object has been
configured with the EnableMfaDelete property. For more information, please see:
.
Sets the BucketName property for this request.
This is the S3 Bucket that contains the S3 Object
you want to delete.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you want to delete.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the VersionId property for this request.
This is the VersionId for the S3 Object you want to Delete.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Sets the MfaCodes property.
The MfaCodes Tuple associates the Serial Number
and the current Token/Code displayed on the
Multi-Factor Authentication device associated with
your AWS Account. This is a required property for this
request if:
1. EnableMfaDelete was configured on the bucket
containing this object's version.
2. You are deleting an object's version
Serial number of the authentication device
Token displayed on the authentication device
this instance
Checks if the MfaCodes property is set.
true if the MfaCodes property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the VersionId property.
Gets and Sets the MfaCodes property.
The MfaCodes Tuple associates the Serial Number
and the current Token/Code displayed on the
Multi-Factor Authentication device associated with
your AWS Account. This is a required property for this
request if:
1. EnableMfaDelete was configured on the bucket
containing this object's version.
2. You are deleting an object's version
The ListVersionsResponse contains the list of Versions in the bucket and
any headers returned by S3.
Gets and sets the Name property.
The bucket's name.
Gets and sets the Prefix property.
Keys that begin with the indicated prefix are listed.
Gets and sets the Versions property. This is a list of
object versions in the bucket that match your search criteria.
Gets and sets the MaxKeys property.
This is the maximum number of keys in the S3ObjectVersions collection.
The value is derived from the MaxKeys parameter to ListVersionsRequest.
Gets and sets the Delimiter property.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
Gets and Sets the IsTruncated property.
This property governs whether
this is the last set of items that match the
specified criteria or whether you need to make
another call to S3 to retrieve more keys.
Gets and sets the KeyMarker property.
Marks the last Key returned in a truncated response.
Gets and sets the VersionIdMarker property.
Marks the last Version-Id returned in a truncated response.
Gets and sets the NextKeyMarker property.
When the number of responses exceeds the value of MaxKeys,
NextKeyMarker specifies the first key not returned that
satisfies the search criteria. Use this value for the
KeyMarker request parameter in a subsequent request.
Gets and sets the NextVersionIdMarker property.
When the number of responses exceeds the value of MaxKeys,
NextVersionIdMarker specifies the first version not returned that
satisfies the search criteria. Use this value for the
VersionIdMarker request parameter in a subsequent request.
The ListMultipartUploadsResponse contains all the information about the
ListMultipartUploads method.
Gets and sets the BucketName property.
Gets and sets the KeyMarker which is the key at or after which the listing began.
Gets and sets the UploadIdMarker property.
Gets and sets the NextKeyMarker property.
When a list is truncated, specifies the last multipart upload that should
be skipped over to resume listing. Use this value for the KeyMarker
request parameter in a subsequent request.
Gets and sets the NextUploadIdMarker property.
When a list is truncated, specifies the last multipart upload that should
be skipped over to resume listing. Use this value for the
UploadIdMarker request parameter in a subsequent request.
Gets and sets the MaxUploads property.
Gets and sets the IsTruncated property.
Indicates whether the returned list of multipart uploads is truncated. A
value true indicates the list was truncated. The list may be truncated if
the number of multipart uploads exceeds the limit specified by
MaxUploads.
Gets and sets the MultipartUploads property.
Container for elements related to a particular multipart upload. A response
can contain zero or more Upload elements.
Gets and sets the Prefix property.
Gets and sets the Delimiter property.
Gets the CommonPrefixes property.
A response can contain CommonPrefixes only if you specify a delimiter.
When you do, CommonPrefixes contains all (if there are any) keys between
Prefix and the next occurrence of the string specified by delimiter. In effect,
CommonPrefixes lists keys that act like subdirectories in the directory specified
by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in
notes/summer/july, the common prefix is notes/summer/.
The CompleteMultipartUploadResponse contains all the information about the
CompleteMultipartUpload method.
Gets and sets the URI that identifies the newly created object.
Gets and sets the name of the bucket that contains the newly created object.
Gets and sets the object key of the newly created object.
Gets and sets Entity tag that identifies the newly created object's data. Objects with different
object data will have different entity tags. The entity tag is an opaque string.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
Computes RFC 2104-compliant HMAC signature.
Signs the specified request with the AWS2 signing protocol by using the
AWS account credentials given in the method parameters.
The AWS public key
The AWS secret key used to sign the request in clear text
The configuration that specifies which hashing algorithm to use
The request to have the signature compute for
The AWS secret key stored in a secure string
If any problems are encountered while signing the request
Restore D B Instance To Point In Time Request Marshaller
Response Unmarshaller for PurchaseReservedDBInstancesOffering operation
Response Unmarshaller for DescribeReservedDBInstances operation
Response Unmarshaller for DescribeReservedDBInstancesOfferings operation
Response Unmarshaller for DescribeDBParameterGroups operation
Response Unmarshaller for DeleteDBSnapshot operation
DBEngineVersion Unmarshaller
Result Unmarshaller for CreateDBSnapshot operation
Returns information about the RestoreDBInstanceFromDBSnapshot response and response metadata.
Gets and sets the RestoreDBInstanceFromDBSnapshotResult property.
Contains the result of a successful invocation of the RestoreDBInstanceFromDBSnapshot
action.
The results from the DescribeEngineDefaultParameters action.
Gets and sets the DescribeEngineDefaultParametersResult property.
Contains the result of a successful invocation of the DescribeEngineDefaultParameters
action.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the DBEngineVersions collection
The values to add to the DBEngineVersions collection
this instance
Adds elements to the DBEngineVersions collection
The values to add to the DBEngineVersions collection
this instance
The identifier returned to allow retrieval of paginated results.
A list of DBEngineVersion elements.
Returns information about the DescribeDBEngineVersionsResult response and response metadata.
Gets and sets the DescribeDBEngineVersionsResult property.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Returns information about the DeleteDBInstance response and response metadata.
Gets and sets the DeleteDBInstanceResult property.
Contains the result of a successful invocation of the DeleteDBInstance
action.
Contains the result of a successful invocation of the following actions:
- CreateDBSnapshot
- DeleteDBSnapshot
This data type is used as a response element in the DescribeDBSnapshots action.
Sets the DBSnapshotIdentifier property
The value to set for the DBSnapshotIdentifier property
this instance
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the SnapshotCreateTime property
The value to set for the SnapshotCreateTime property
this instance
Sets the Engine property
The value to set for the Engine property
this instance
Sets the AllocatedStorage property
The value to set for the AllocatedStorage property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the InstanceCreateTime property
The value to set for the InstanceCreateTime property
this instance
Sets the MasterUsername property
The value to set for the MasterUsername property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Specifies the identifier for the DB Snapshot.
Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
Provides the time (UTC) when the snapshot was taken.
Specifies the name of the database engine.
Specifies the allocated storage size in gigabytes (GB).
Specifies the status of this DB Snapshot.
Specifies the port that the database engine was listening on at the time of the snapshot.
Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
Specifies the time (UTC) when the snapshot was taken.
Provides the master username for the DB Instance.
Specifies the version of the database engine.
License model information for the restored DB Instance.
AmazonRDS exception
Constructs a new DBSecurityGroupNotFoundException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the following actions:
- DescribeDBSecurityGroups
- AuthorizeDBSecurityGroupIngress
- CreateDBSecurityGroup
- RevokeDBSecurityGroupIngress
This data type is used as a response element in the DescribeDBSecurityGroups action.
Sets the OwnerId property
The value to set for the OwnerId property
this instance
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the DBSecurityGroupDescription property
The value to set for the DBSecurityGroupDescription property
this instance
Adds elements to the EC2SecurityGroups collection
The values to add to the EC2SecurityGroups collection
this instance
Adds elements to the EC2SecurityGroups collection
The values to add to the EC2SecurityGroups collection
this instance
Adds elements to the IPRanges collection
The values to add to the IPRanges collection
this instance
Adds elements to the IPRanges collection
The values to add to the IPRanges collection
this instance
Provides the AWS ID of the owner of a specific DB Security Group.
Specifies the name of the DB Security Group.
Provides the description of the database security group.
Contains a list of EC2SecurityGroup elements.
Contains a list of IPRange elements.
Get Status Request Marshaller
Create Job Request Marshaller
AmazonImportExport exception
Constructs a new MissingCustomsException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new MalformedManifestException with the specified error
message.
Describes the error encountered.
Container for the parameters to the GetStatus operation.
This operation returns information about a job, including where
the job is in the processing pipeline, the status of the results, and
the signature value associated with the job. You can only return
information about jobs you own.
Sets the JobId property
The value to set for the JobId property
this instance
A unique identifier which refers to a particular job.
Returns information about the CreateJobResult response and response metadata.
Gets and sets the CreateJobResult property.
Output structure for the CreateJob operation.
The User data type contains information about a User.
This data type is used as a response element in the following
actions:
- CreateUser
- GetUser
- ListUsers
Sets the Path property
The value to set for the Path property
this instance
Sets the UserName property
The value to set for the UserName property
this instance
Sets the UserId property
The value to set for the UserId property
this instance
Sets the Arn property
The value to set for the Arn property
this instance
Sets the CreateDate property
The value to set for the CreateDate property
this instance
Path to the User name. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
The name identifying the User.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The stable and unique string identifying the User. For more information about IDs, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The Amazon Resource Name (ARN) specifying the User. For more information about ARNs and how to use them in policies, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
20 - 2048
The date when the User was created.
Update Server Certificate Request Marshaller
Resync M F A Device Request Marshaller
Response Unmarshaller for ListUserPolicies operation
ListSigningCertificatesResult Unmarshaller
List Group Policies Request Marshaller
Get User Policy Request Marshaller
Get Server Certificate Request Marshaller
Get Account Summary Request Marshaller
Response Unmarshaller for EnableMFADevice operation
Returns information about the RemoveUserFromGroup response metadata.
The RemoveUserFromGroup operation has a void result type.
The LoginProfile data type contains information about a login
profile for a User. This data type is used as a response
element in the actions CreateLoginProfile and GetLoginProfile.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the CreateDate property
The value to set for the CreateDate property
this instance
The name of the User, which can be used for logins.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The date when the login profile for the User was created.
Contains the result of a successful invocation of the
ListGroupsForUser action.
Adds elements to the Groups collection
The values to add to the Groups collection
this instance
Adds elements to the Groups collection
The values to add to the Groups collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of groups.
A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more groups in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the GetServerCertificateResult response and response metadata.
Gets and sets the GetServerCertificateResult property.
Contains the result of a successful invocation of the GetServerCertificate action.
Returns information about the DeleteGroup response metadata.
The DeleteGroup operation has a void result type.
DescribeJobFlowsResult Unmarshaller
Combines the execution state and configuration of a step.
Sets the StepConfig property
The value to set for the StepConfig property
this instance
Sets the ExecutionStatusDetail property
The value to set for the ExecutionStatusDetail property
this instance
The step configuration.
The description of the step status.
Specifies the Amazon EC2 location for the job flow.
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
The Amazon EC2 Availability Zone for the job flow.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A description of the Amazon EC2 instance running the job flow.
Sets the MasterInstanceType property
The value to set for the MasterInstanceType property
this instance
Sets the SlaveInstanceType property
The value to set for the SlaveInstanceType property
this instance
Sets the InstanceCount property
The value to set for the InstanceCount property
this instance
Adds elements to the InstanceGroups collection
The values to add to the InstanceGroups collection
this instance
Sets the Ec2KeyName property
The value to set for the Ec2KeyName property
this instance
Sets the Placement property
The value to set for the Placement property
this instance
Sets the KeepJobFlowAliveWhenNoSteps property
The value to set for the KeepJobFlowAliveWhenNoSteps property
this instance
Sets the HadoopVersion property
The value to set for the HadoopVersion property
this instance
The EC2 instance type of the master node.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The EC2 instance type of the slave nodes.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The number of Amazon EC2 instances used to execute the job flow.
Configuration for the job flow's instance groups.
Specifies the name of the Amazon EC2 key pair that can be used to ssh
to the master node as the user called "hadoop."
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the Availability Zone the job flow will run in.
Specifies whether the job flow should terminate after completing all
steps.
Specifies the Hadoop version for the job flow. Valid inputs are "0.18"
or "0.20".
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A description of a job flow.
Sets the JobFlowId property
The value to set for the JobFlowId property
this instance
Sets the Name property
The value to set for the Name property
this instance
Sets the LogUri property
The value to set for the LogUri property
this instance
Sets the ExecutionStatusDetail property
The value to set for the ExecutionStatusDetail property
this instance
Sets the Instances property
The value to set for the Instances property
this instance
Adds elements to the Steps collection
The values to add to the Steps collection
this instance
Adds elements to the BootstrapActions collection
The values to add to the BootstrapActions collection
this instance
The job flow identifier.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the job flow.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The location in Amazon S3 where log files for the job are stored.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Describes the execution status of the job flow.
Describes the Amazon EC2 instances of the job flow.
A list of steps run by the job flow.
A list of the bootstrap actions run by the job flow.
Set Load Balancer Listener S S L Certificate Request Marshaller
Describe Load Balancers Request Marshaller
Container for the parameters to the SetLoadBalancerPoliciesOfListener operation.
Associates, updates, or disables a policy with a listener on the load balancer. Currently only zero (0) or one (1) policy can be
associated with a listener.
Default constructor for a new SetLoadBalancerPoliciesOfListenerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new SetLoadBalancerPoliciesOfListenerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The external port of the LoadBalancer with which this policy has to be associated.
List of policies to be associated with the listener. Currently this list can have at most one policy. If the list
is empty, the current policy is removed from the listener.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the LoadBalancerPort property
The value to set for the LoadBalancerPort property
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The external port of the LoadBalancer with which this policy has to be associated.
List of policies to be associated with the listener. Currently this list can have at most one policy. If the list is empty, the current
policy is removed from the listener.
AmazonElasticLoadBalancing exception
Constructs a new InvalidInstanceException with the specified error
message.
Describes the error encountered.
Returns information about the CreateLoadBalancerResult response and response metadata.
Gets and sets the CreateLoadBalancerResult property.
The output for the CreateLoadBalancer action.
Container for the parameters to the UpdateEnvironment operation.
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new
configuration template, or updates select configuration option values in the running environment. Attempting to update both
the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and
DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
The ID of the environment to update. If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Constraints:
-
Length
4 - 23
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application
version is found, returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration
template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
Constraints:
-
Length
0 - 200
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified
configuration options to the requested value.
A list of custom user-defined configuration options to remove from the configuration set for this environment.
S3Location Unmarshaller
DescribeApplicationsResult Unmarshaller
Delete Environment Configuration Request Marshaller
Describes the solution stack.
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Adds elements to the PermittedFileTypes collection
The values to add to the PermittedFileTypes collection
this instance
Adds elements to the PermittedFileTypes collection
The values to add to the PermittedFileTypes collection
this instance
The name of the solution stack.
Constraints:
-
Length
0 - 100
The permitted file types allowed for a solution stack.
Container for the parameters to the DeleteApplicationVersion operation.
Deletes the specified version from the specified application. NOTE:You cannot delete an application version that
is associated with a running environment.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the DeleteSourceBundle property
The value to set for the DeleteSourceBundle property
this instance
The name of the application to delete releases from.
Constraints:
-
Length
1 - 100
The label of the version to delete.
Constraints:
-
Length
1 - 100
Indicates whether to delete the associated source bundle from Amazon S3: - true: An attempt is made to delete the associated
Amazon S3 source bundle specified at time of creation.
- false: No action is taken on the Amazon S3 source bundle specified
at time of creation.
Valid Values: true | false
VPN Gateway
Sets the VpnGatewayId property
The ID of the VPN gateway
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Sets the VpnGatewayState property
The current state of the VPN gateway (pending,
available, deleting, deleted)
this instance
Checks if VpnGatewayState property is set
true if VpnGatewayState property is set
Sets the Type property
The type of VPN connection the VPN gateway supports (ipsec.1)
this instance
Checks if Type property is set
true if Type property is set
Sets the AvailabilityZone property
The Availability Zone where the VPN gateway was created
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the VpcAttachment property
list of VPC attachments
this instance
Checks if VpcAttachment property is set
true if VpcAttachment property is set
Sets the Tag property
A list of tags for the VpnGateway.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the VpnGatewayId property.
The ID of the VPN gateway
Gets and sets the VpnGatewayState property.
The current state of the VPN gateway (pending,
available, deleting, deleted)
Gets and sets the Type property.
The type of VPN connection the VPN gateway supports (ipsec.1)
Gets and sets the AvailabilityZone property.
The Availability Zone where the VPN gateway was created
Gets and sets the VpcAttachment property.
list of VPC attachments
Gets and sets the Tag property.
A list of tags for the VpnGateway.
Sets the RouteTableId property
The route table's ID.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the VpcId property
The ID of the VPC the route table is in.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the Routes property
A list of routes in the route table.
this instance
Checks if Routes property is set
true if Routes property is set
Sets the Associations property
A list of associations between the route table and one or more
subnets.
this instance
Checks if Associations property is set
true if Associations property is set
Sets the Tag property
A list of tags for the RouteTable.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the RouteTableId property.
The route table's ID.
Gets and sets the VpcId property.
The ID of the VPC the route table is in.
Gets and sets the Routes property.
A list of routes in the route table.
Gets and sets the Associations property.
A list of associations between the route table and one or more
subnets.
Gets and sets the Tag property.
A list of tags for the RouteTable.
Sets the ResourceId property
The resource ID for the Tag.
this instance
Checks if ResourceId property is set
true if ResourceId property is set
Sets the ResourceType property
The type of resource identified by the associated resource ID
(ex: instance, AMI, EBS volume, etc).
this instance
Checks if ResourceType property is set
true if ResourceType property is set
Sets the Key property
The tag's key.
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
The tag's value.
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the ResourceId property.
The resource ID for the Tag.
Gets and sets the ResourceType property.
The type of resource identified by the associated resource ID
(ex: instance, AMI, EBS volume, etc).
Gets and sets the Key property.
The tag's key.
Gets and sets the Value property.
The tag's value.
Password Data
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Timestamp property
The time the data was last updated.
this instance
Checks if Timestamp property is set
true if Timestamp property is set
Sets the Data property
The password of the instance.
this instance
Checks if Data property is set
true if Data property is set
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the Timestamp property.
The time the data was last updated.
Gets and sets the Data property.
The password of the instance.
Part of a request to launch Amazon EC2 instances,
specifying which license pool to use if a license should be
attached to the new Amazon EC2 instance.
Sets the Pool property
The license pool from which to take a license when starting
Amazon EC2 instances in the associated RunInstances request.
this instance
Checks if Pool property is set
true if Pool property is set
Gets and sets the Pool property.
The license pool from which to take a license when starting
Amazon EC2 instances in the associated RunInstances request.
Sets the Volumes property
A list of instance volumes for import. Each volume's information is wrapped in an item element.
this instance
Checks if Volumes property is set
true if Volumes property is set
Sets the InstanceId property
The ID of the resulting instance in Amazon EC2.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Platform property
Instance operating system.
this instance
Checks if Platform property is set
true if Platform property is set
Sets the Description property
Optional description of the instance.
this instance
Checks if Description property is set
true if Description property is set
Gets and sets the Volumes property.
A list of instance volumes for import. Each volume's information is wrapped in an item element.
Gets and sets the InstanceId property.
The ID of the resulting instance in Amazon EC2.
Gets and sets the Platform property.
Instance operating system.
Gets and sets the Description property.
Optional description of the instance.
The Response for the
DescribeTags operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeTagsResult property is set
true if DescribeTagsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeTagsResult property.
DescribeTags Result
Describe Snapshots Result
Checks if Snapshot property is set
true if Snapshot property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Snapshot property.
List of snapshots
Returns information about an attribute of a
snapshot. Only one attribute
can be specified
per call.
Sets the SnapshotId property
The ID of the Amazon EBS snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the Attribute property
Describes the create volume permissions of the
snapshot.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the SnapshotId property.
The ID of the Amazon EBS snapshot.
Gets and sets the Attribute property.
Describes the create volume permissions of the
snapshot.
Describe Security Groups Result
Checks if SecurityGroup property is set
true if SecurityGroup property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SecurityGroup property.
List of security groups
Describe Instances Result
Checks if Reservation property is set
true if Reservation property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Reservation property.
List of reservations
Describe Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeInstancesResult property is set
true if DescribeInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeInstancesResult property.
Describe Instances Result
Gives you information about your customer gateways. You can filter the
results to return information only about customer gateways that match criteria you
specify. For example, you could ask to get information about a particular
customer gateway (or all) only if the gateway's state is pending or
available. You can specify multiple filters (e.g., the customer
gateway has a particular IP address for the Internet-routable
external interface, and the gateway's state is pending or
available). The result includes information for a particular
customer gateway only if the gateway matches all your
filters. If there's no match, no special message is returned; the response
is simply empty
Sets the CustomerGatewayId property
A customer gateway ID. You can specify more
than one in the
request
this instance
Checks if CustomerGatewayId property is set
true if CustomerGatewayId property is set
Sets the Filter property
The filter to apply on the results of DescribeCustomerGateways.
Filters can be:
a. state - The state of the Customer Gateway. (pending,
available, deleting, deleted).
b. type - The type of Customer Gateway. Currently the only
supported type is ipsec.1.
c. ipAddress - The IP address of the customer gateway's
Internet-routable external interface (e.g., 12.1.2.3).
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the CustomerGatewayId property.
A customer gateway ID. You can specify more
than one in the
request
Gets and sets the Filter property.
The filter to apply on the results of DescribeCustomerGateways.
Filters can be:
a. state - The state of the Customer Gateway. (pending,
available, deleting, deleted).
b. type - The type of Customer Gateway. Currently the only
supported type is ipsec.1.
c. ipAddress - The IP address of the customer gateway's
Internet-routable external interface (e.g., 12.1.2.3).
Creates a new route table within a VPC. After you create a new route table, you can add routes and
associate the table with a subnet. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Sets the VpcId property
The ID of the VPC.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the VpcId property.
The ID of the VPC.
Metric Unmarshaller
Describe Alarms Request Marshaller
Response Unmarshaller for DescribeAlarmsForMetric operation
DescribeAlarmHistoryResult Unmarshaller
Container for the parameters to the GetMetricStatistics operation.
Gets statistics for the specified metric.
NOTE: The maximum number of data points returned from a
single GetMetricStatistics request is 1,440. If a request is made that
generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified
time range or increasing the specified period. Alternatively, make
multiple requests across adjacent time ranges. Amazon
CloudWatch aggregates data points based on the length of the
period 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. NOTE: The maximum number of data
points that can be queried is 50,850; whereas the maximum number of
data points returned is 1,440. The following examples
show various statistics allowed by the data point query maximum of
50,850 when you call GetMetricStatistics on Amazon EC2
instances with detailed (one-minute) monitoring enabled:
- Statistics for up to 400 instances for a span of one hour
- Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the MetricName property
The value to set for the MetricName property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the EndTime property
The value to set for the EndTime property
this instance
Sets the Period property
The value to set for the Period property
this instance
Adds elements to the Statistics collection
The values to add to the Statistics collection
this instance
Adds elements to the Statistics collection
The values to add to the Statistics collection
this instance
Sets the Unit property
The value to set for the Unit property
this instance
The namespace of the metric.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The name of the metric.
Constraints:
-
Length
1 - 255
A list of dimensions describing qualities of the metric.
Constraints:
-
Length
0 - 10
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 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.
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 granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default
value is 60.
Constraints:
-
Range
60 -
The metric statistics to return.
Constraints:
-
Length
1 - 5
The unit for the metric.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
The DimensionFilter data type is used to filter
ListMetrics results.
Sets the Name property
The value to set for the Name property
this instance
Sets the Value property
The value to set for the Value property
this instance
The dimension name to be matched.
Constraints:
-
Length
1 - 255
The value of the dimension to be matched. Specifying a Name without specifying a Value returns all values associated
with that Name.
Constraints:
-
Length
1 - 255
Container for the parameters to the DeleteAlarms operation.
Deletes all specified alarms. In the event of an error, no
alarms are deleted.
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
A list of alarms to be deleted.
Constraints:
-
Length
0 - 100
Configuration for accessing Amazon CloudWatch service
This class is the base class of all the configurations settings to connect
to a service.
Gets Service Version
Gets and sets of the signatureMethod property.
Gets and sets of the SignatureVersion property.
Gets and sets of the UserAgent property.
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint or want to switch between https and http.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureStringForAwsSecretKey property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
Default constructor
Gets the ServiceVersion property.
The GetOriginAccessIdentityInfoResponse contains all the information about the
GetOriginAccessIdentityInfo operation and any headers returned by CloudFront.
Base class for all CloudFront operation responses.
Provides a header collection which is used to store the response headers.
Also exposes the RequestId and AmazonId2 from CloudFront responses.
The ETag Header returned by CloudFront that uniquely
identifies the configuration or information returned
web headers for all requests.
Returns the string representation of the response.
A string representing the response.
Gets and sets the RequestId property.
Gets and sets the Headers property.
Gets and sets the XML property. This is the
original XML response received from CloudFront
Gets and sets the ETag property.
Gets and sets the OriginAccessIdentity property.
This contains all the information (including the configuration) for a
CloudFront Origin Access Identity.
Gets and sets the ETag property.
The Origin Access Identity's ETag is also set if
possible.
The GetOriginAccessIdentityInfoRequest contains the parameters used for the GetOriginAccessIdentityInfo operation.
Required Parameter: Id
Sets the Id property of this request to the value passed in.
The OriginAccessIdentity's id
The request with the Id property set
Gets and sets the Id property for the Origin Access Identity
The CreateStreamingDistributionRequest contains the parameters used for the CreateStreamingDistribution operation.
Sets the StreamingDistributionConfig property for this request.
The value that StreamingDistributionConfig is set to
the request with the Id set
Gets and Sets the StreamingDistributionConfig property.
AmazonCloudFrontClient is an implementation of AmazonCloudFront; the client allows you to manage your CloudFront
distributions and origin access identities.
If you want to use the AmazonCloudFrontClient from a Medium Trust hosting environment, please create the
client with an AmazonCloudFrontConfig object whose UseSecureStringForAwsSecretKey property is false.
Amazon CloudFront provides a simple web services interface that can be used to store and retrieve any amount of data,
at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable,
fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites.
The service aims to maximize benefits of scale and to pass those benefits on to developers.
Interface for Amazon CloudFront Clients.
For more information about Amazon CloudFront,
List Distributions
List Distributions Response from the service
The ListDistributions operation lists all of the distributions associated with
your account.
List Distributions
The ListDistributionsRequest with values for
the Marker and MaxItems properties set
List Distributions Response from the service
The ListDistributions operation lists all of the distributions associated with
your account.
The GetDistributionConfig gets the Configuration for the CloudFront distribution.
For more information on the format of the CloudFront Distribution Configuration object,
please refer:
The GetDistributionConfigRequest that defines the parameters of the operation.
Returns a GetDistributionConfigResponse from CloudFront.
The GetDistributionInfo operation gets the complete information asociated with a distribution.
For more information on what information is returned by CloudFront, please refer:
-
and
The GetDistributionInfoRequest that defines the parameters of the operation.
Returns a GetDistributionInfoResponse from CloudFront.
The SetDistributionConfig operation sets the configuration for a CloudFront distribution.
The returned response contains only the headers from CloudFront.
The SetDistributionConfigRequest that defines the parameters of the operation.
Returns a SetDistributionConfigResponse from CloudFront.
The CreateDistribution operation creates a new CloudFront Distribution.
The CreateDistributionRequest that defines the parameters of the operation.
Returns a CreateDistributionResponse from CloudFront.
The DeleteDistribution operation deletes the distribution specified in the request.
The DeleteDistributionRequest that defines the parameters of the operation.
Returns a DeleteDistributionResponse from CloudFront.
The CreateOriginAccessIdentity operation creates a new CloudFront Access Identity.
You can create up to 100 per AWS account.
The CreateOriginAccessIdentityRequest that defines the parameters of the operation.
Returns a CreateOriginAccessIdentityResponse from CloudFront.
The DeleteOriginAccessIdentity operation deletes the origin access identity specified in the request.
The DeleteOriginAccessIdentityRequest that defines the parameters of the operation.
Returns a DeleteOriginAccessIdentityResponse from CloudFront.
The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities
owned by the authenticated sender of the request.
Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.
The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities
owned by the authenticated sender of the request.
The ListOriginAccessIdentitiesRequest with values for
the Marker and MaxItems properties set
Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.
The GetOriginAccessIdentityInfo operation gets the complete information asociated with an Origin Access Identity.
For more information on what information is returned by CloudFront, please refer:
-
-
The GetOriginAccessIdentityInfoRequest that defines the parameters of the operation.
Returns a GetOriginAccessIdentityInfoResponse from CloudFront.
The GetOriginAccessIdentityConfig gets the Configuration for the CloudFront Origin Access Identity.
For more information on the format of the CloudFront Origin Access Identity Configuration object,
please refer:
The GetOriginAccessIdentityConfigRequest that defines the parameters of the operation.
Returns a GetOriginAccessIdentityConfigResponse from CloudFront.
The SetOriginAccessIdentityConfig operation sets the configuration for a CloudFront Origin Access Identity.
The returned response contains only the headers from CloudFront.
The SetOriginAccessIdentityConfigRequest that defines the parameters of the operation.
Returns a SetOriginAccessIdentityConfigResponse from CloudFront.
List CloudFront Streaming Distributions
List Streaming Distributions Response from the service
The ListStreamingDistributions operation lists all of the streaming distributions
associated with your account.
List CloudFront Streaming Distributions
The ListStreamingDistributionsRequest with values for
the Marker and MaxItems properties set
List Streaming Distributions Response from the service
The ListStreamingDistributions operation lists all of the distributions associated with
your account.
The GetStreamingDistributionConfig gets the Configuration for the streaming distribution.
For more information on the format of the CloudFront StreamingDistribution Configuration object,
please refer:
The GetStreamingDistributionConfigRequest that defines the parameters of the operation.
Returns a GetStreamingDistributionConfigResponse from CloudFront.
The GetStreamingDistributionInfo operation gets the complete information asociated with a streaming distribution.
For more information on what information is returned by CloudFront, please refer:
-
-
The GetStreamingDistributionInfoRequest that defines the parameters of the operation.
Returns a GetStreamingDistributionInfoResponse from CloudFront.
The SetStreamingDistributionConfig operation sets the configuration for a CloudFront
streaming distribution. The returned response contains only the headers from CloudFront.
The SetStreamingDistributionConfigRequest that defines the parameters of the operation.
Returns a SetStreamingDistributionConfigResponse from CloudFront.
The CreateStreamingDistribution operation creates a new CloudFront StreamingDistribution.
The CreateStreamingDistributionRequest that defines the parameters of the operation.
Returns a CreateStreamingDistributionResponse from CloudFront.
The DeleteStreamingDistribution operation deletes the streaming distribution specified in the request.
The DeleteStreamingDistributionRequest that defines the parameters of the operation.
Returns a DeleteStreamingDistributionResponse from CloudFront.
The PostInvalidation operation invalidates objects specified in the PostInvalidationRequest which will
cause Cloudfront to go back to the origin to get a new copy.
PostInvalidationRequest request = new PostInvalidationRequest();
request.DistributionId = distributionId;
request.InvalidationBatch.CallerReference = callerReference;
request.InvalidationBatch.WithPaths("/image1.jpg", "/image2.jpg");
PostInvalidationResponse response = cfcClient.PostInvalidation(request);
The PostInvalidationRequest that defines the parameters of the operation.
Returns a PostInvalidationResponse from CloudFront.
The GetInvalidationList operation will return back a list of all the invalidations done for a distribution for the
current and previous billing period. If the list is long, you can paginate it using the MaxItems
and Marker parameters
GetInvalidationListRequest request = new GetInvalidationListRequest();
request.DistributionId = distributionId;
GetInvalidationListResponse response = cfcClient.GetInvalidationList(request);
The GetInvalidationListRequest that defines the parameters of the operation. Distribution id is a required parameter.
Returns a GetInvalidationListResponse from CloudFront.
The GetInvalidation operation returns back the details for a specific invalidation.
GetInvalidationRequest request = new GetInvalidationRequest()
.WithDistribtionId(distributionId)
.WithInvalidationId(invalidationId);
GetInvalidationResponse response = cfcClient.GetInvalidation(request);
The GetInvalidationRequest that defines the parameters of the operation. Distribution id and Invalidation id are required parameters.
Returns a GetInvalidationResponse from CloudFront.
Implements the Dispose pattern for the AmazonS3Client
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an
AmazonCloudFront Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The CloudFront Configuration Object
Constructs an AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an
Amazon CloudFront Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The CloudFront Configuration Object
The PostInvalidation operation invalidates objects specified in the PostInvalidationRequest which will
cause Cloudfront to go back to the origin to get a new copy.
PostInvalidationRequest request = new PostInvalidationRequest();
request.DistributionId = distributionId;
request.InvalidationBatch.CallerReference = callerReference;
request.InvalidationBatch.WithPaths("/image1.jpg", "/image2.jpg");
PostInvalidationResponse response = cfcClient.PostInvalidation(request);
The PostInvalidationRequest that defines the parameters of the operation.
Returns a PostInvalidationResponse from CloudFront.
The GetInvalidationList operation will return back a list of all the invalidations done for a distribution for the
current and previous billing period. If the list is long, you can paginate it using the MaxItems
and Marker parameters
GetInvalidationListRequest request = new GetInvalidationListRequest();
request.DistributionId = distributionId;
GetInvalidationListResponse response = cfcClient.GetInvalidationList(request);
The GetInvalidationListRequest that defines the parameters of the operation. Distribution id is a required parameter.
Returns a GetInvalidationListResponse from CloudFront.
The GetInvalidation operation returns back the details for a specific invalidation.
GetInvalidationRequest request = new GetInvalidationRequest()
.WithDistribtionId(distributionId)
.WithInvalidationId(invalidationId);
GetInvalidationResponse response = cfcClient.GetInvalidation(request);
The GetInvalidationRequest that defines the parameters of the operation. Distribution id and Invalidation id are required parameters.
Returns a GetInvalidationResponse from CloudFront.
The ListDistributions operation returns a list of all of the distributions
owned by the authenticated sender of the request.
Returns a ListDistributionsResponse with the response from CloudFront.
The ListDistributions operation returns a list of all of the distributions
owned by the authenticated sender of the request.
The ListDistributionsRequest with values for
the Marker and MaxItems properties set
Returns a ListDistributionsResponse with the response from CloudFront.
The GetDistributionConfig gets the Configuration for the CloudFront distribution.
For more information on the format of the CloudFront Distribution Configuration object,
please refer:
The GetDistributionConfigRequest that defines the parameters of the operation.
Returns a GetDistributionConfigResponse from CloudFront.
The GetDistributionInfo operation gets the complete information asociated with a distribution.
For more information on what information is returned by CloudFront, please refer:
-
-
The GetDistributionInfoRequest that defines the parameters of the operation.
Returns a GetDistributionInfoResponse from CloudFront.
The SetDistributionConfig operation sets the configuration for a CloudFront distribution.
The SetDistributionConfigRequest that defines the parameters of the operation.
Returns a SetDistributionConfigResponse from CloudFront.
The CreateDistribution operation creates a new CloudFront Distribution.
POST Distribution API Reference
The CreateDistributionRequest that defines the parameters of the operation.
Returns a CreateDistributionResponse from CloudFront.
The DeleteDistribution operation deletes the distribution specified in the request.
Deleting a Distribution Developer Guide
The DeleteDistributionRequest that defines the parameters of the operation.
Returns a DeleteDistributionResponse from CloudFront.
The CreateOriginAccessIdentity operation creates a new CloudFront Access Identity.
You can create up to 100 per AWS account.
The CreateOriginAccessIdentityRequest that defines the parameters of the operation.
Returns a CreateOriginAccessIdentityResponse from CloudFront.
The DeleteOriginAccessIdentity operation deletes the origin access identity specified in the request.
The DeleteOriginAccessIdentityRequest that defines the parameters of the operation.
Returns a DeleteOriginAccessIdentityResponse from CloudFront.
The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities
owned by the authenticated sender of the request.
Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.
The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities
owned by the authenticated sender of the request.
The ListOriginAccessIdentitiesRequest with values for
the Marker and MaxItems properties set
Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.
The GetOriginAccessIdentityInfo operation gets the complete information asociated with an Origin Access Identity.
For more information on what information is returned by CloudFront, please refer:
-
-
The GetOriginAccessIdentityInfoRequest that defines the parameters of the operation.
Returns a GetOriginAccessIdentityInfoResponse from CloudFront.
The GetOriginAccessIdentityConfig gets the Configuration for the CloudFront Origin Access Identity.
For more information on the format of the CloudFront Origin Access Identity Configuration object,
please refer:
The GetOriginAccessIdentityConfigRequest that defines the parameters of the operation.
Returns a GetOriginAccessIdentityConfigResponse from CloudFront.
The SetOriginAccessIdentityConfig operation sets the configuration for a CloudFront Origin Access Identity.
The SetOriginAccessIdentityConfigRequest that defines the parameters of the operation.
Returns a SetOriginAccessIdentityConfigResponse from CloudFront.
List CloudFront Streaming Distributions
List Streaming Distributions Response from the service
The ListStreamingDistributions operation lists all of the streaming distributions
associated with your account.
List CloudFront Streaming Distributions
The ListStreamingDistributionsRequest with values for
the Marker and MaxItems properties set
List Streaming Distributions Response from the service
The ListStreamingDistributions operation lists all of the distributions associated with
your account.
The GetStreamingDistributionConfig gets the Configuration for the streaming distribution.
For more information on the format of the CloudFront StreamingDistribution Configuration object,
please refer:
The GetStreamingDistributionConfigRequest that defines the parameters of the operation.
Returns a GetStreamingDistributionConfigResponse from CloudFront.
The GetStreamingDistributionInfo operation gets the complete information asociated with a streaming distribution.
For more information on what information is returned by CloudFront, please refer:
-
-
The GetStreamingDistributionInfoRequest that defines the parameters of the operation.
Returns a GetStreamingDistributionInfoResponse from CloudFront.
The SetStreamingDistributionConfig operation sets the configuration for a CloudFront distribution.
The SetStreamingDistributionConfigRequest that defines the parameters of the operation.
Returns a SetStreamingDistributionConfigResponse from CloudFront.
The CreateStreamingDistribution operation creates a new CloudFront StreamingDistribution.
POST Streaming Distribution API Reference
The CreateStreamingDistributionRequest that defines the parameters of the operation.
Returns a CreateStreamingDistributionResponse from CloudFront.
The DeleteStreamingDistribution operation deletes the distribution specified in the request.
The DeleteStreamingDistributionRequest that defines the parameters of the operation.
Returns a DeleteStreamingDistributionResponse from CloudFront.
Convert ListDistributionsRequest to key/value pairs
Convert GetDistributionInfoRequest to key/value pairs.
Convert GetDistributionConfigRequest to key/value pairs.
Convert SetDistributionInfoRequest to key/value pairs.
Convert CreateDistributionRequest to key/value pairs.
Convert DeleteDistributionRequest to key/value pairs.
Convert CreateOriginAccessIdentityRequest to key/value pairs.
Convert DeleteOriginAccessIdentityRequest to key/value pairs.
Convert ListOriginAccessIdentitiessRequest to key/value pairs
Convert GetOriginAccessIdentityInfoRequest to key/value pairs.
Convert GetOriginAccessIdentityConfigRequest to key/value pairs.
Convert SetOriginAccessIdentityInfoRequest to key/value pairs.
Convert ListStreamingDistributionsRequest to key/value pairs
Convert CreateStreamingDistributionRequest to key/value pairs.
Convert GetStreamingDistributionInfoRequest to key/value pairs.
Convert GetStreamingDistributionConfigRequest to key/value pairs.
Convert SetStreamingDistributionInfoRequest to key/value pairs.
Convert DeleteStreamingDistributionRequest to key/value pairs.
Add authentication related and version parameters
Invoke request and return response
Sets the headers we want to expose to the user from the response.
Configure HttpClient with set of defaults as well as configuration
from AmazonEC2Config instance
Exponential sleep on failed request
Creates a string based on the parameters and encrypts it using
key. Returns the encrypted string.
Creates a string based on the parameters and encrypts it using
key. Returns the encrypted string.
StackEvent Unmarshaller
Parameter Unmarshaller
Describe Stacks Request Marshaller
DescribeStackResourcesResult Unmarshaller
Container for the parameters to the DescribeStackResources operation.
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that
are part of the stack are returned. If PhysicalResourceId is specified, all the associated resources of the stack the resource
belongs to are returned. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
stack has been deleted. You must specify StackName or PhysicalResourceId. In addition, you can specify
LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and
PhysicalResourceId , go to the AWS CloudFormation User Guide. NOTE: A ValidationError is returned if you specify
both StackName and PhysicalResourceId in the same request.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
Sets the PhysicalResourceId property
The value to set for the PhysicalResourceId property
this instance
The name or the unique identifier associated with the stack. Default: There is no default value.
The logical name of the resource as specified in the template.
Default: There is on default value.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an
Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2
InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the
stack. Default: There is no default value.
MetricGranularityType Unmarshaller
BlockDeviceMapping Unmarshaller
Activity Unmarshaller
The ScalingPolicy data type.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the ScalingAdjustment property
The value to set for the ScalingAdjustment property
this instance
Sets the AdjustmentType property
The value to set for the AdjustmentType property
this instance
Sets the Cooldown property
The value to set for the Cooldown property
this instance
Sets the PolicyARN property
The value to set for the PolicyARN property
this instance
Adds elements to the Alarms collection
The values to add to the Alarms collection
this instance
Adds elements to the Alarms collection
The values to add to the Alarms collection
this instance
The name of the Auto Scaling group associated with this scaling policy.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the scaling policy.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The number associated with the specified AdjustmentType. A positive value adds to the current capacity and a negative value removes from the
current capacity.
Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and PercentOfCapacity.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
The Amazon Resource Name (ARN) of the policy.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of CloudWatch Alarms related to the policy.
The InstanceMonitoring Data Type.
Sets the Enabled property
The value to set for the Enabled property
this instance
If true, instance monitoring is enabled.
Returns information about the DescribeScheduledActionsResult response and response metadata.
Gets and sets the DescribeScheduledActionsResult property.
A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.
Returns information about the DescribeAutoScalingInstancesResult response and response metadata.
Gets and sets the DescribeAutoScalingInstancesResult property.
The AutoScalingInstancesType data type.
Specifies whether the PutScalingPolicy ScalingAdjustment parameter is an absolute number or a percentage of the current
capacity.
Sets the Name property
The value to set for the Name property
this instance
A policy adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
An AWS access control policy is a object that acts as a container for one or
more statements, which specify fine grained rules for allowing or denying
various types of actions from being performed on your AWS resources.
By default, all requests to use your resource coming from anyone but you are
denied. Access control polices can override that by allowing different types
of access to your resources, or by explicitly denying different types of
access.
Each statement in an AWS access control policy takes the form:
"A has permission to do B to C where D applies".
-
A is the prinicpal
The AWS account that is making a request to
access or modify one of your AWS resources.
-
B is the action
the way in which your AWS resource is being accessed or modified, such
as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket.
-
C is the resource
your AWS entity that the principal wants to access, such
as an Amazon SQS queue, or an object stored in Amazon S3.
-
D is the set of conditions
optional constraints that specify when to allow or deny
access for the principal to access your resource. Many expressive conditions are available,
some specific to each service. For example you can use date conditions to allow access to
your resources only after or before a specific time.
Note that an AWS access control policy should not be confused with the
similarly named "POST form policy" concept used in Amazon S3.
The default policy version
Constructs an empty AWS access control policy ready to be populated with
statements.
Constructs a new AWS access control policy with the specified policy ID.
The policy ID is a user specified string that serves to help developers
keep track of multiple polices. Policy IDs are often used as a human
readable name for a policy.
The policy ID for the new policy object. Policy IDs serve to
help developers keep track of multiple policies, and are often
used to give the policy a meaningful, human readable name.
Constructs a new AWS access control policy with the specified policy ID
and collection of statements. The policy ID is a user specified string
that serves to help developers keep track of multiple polices. Policy IDs
are often used as a human readable name for a policy.
The policy ID for the new policy object. Policy IDs serve to
help developers keep track of multiple policies, and are often
used to give the policy a meaningful, human readable name.
The statements to include in the new policy.
Sets the policy ID for this policy and returns the updated policy so that
multiple calls can be chained together.
Policy IDs serve to help developers keep track of multiple policies, and
are often used as human readable name for a policy.
The polich ID for this policy
this instance
Sets the collection of statements contained by this policy and returns
this policy object so that additional method calls can be chained
together.
Individual statements in a policy are what specify the rules that enable
or disable access to your AWS resources.
The collection of statements included in this policy.
this instance
Returns a JSON string representation of this AWS access control policy,
suitable to be sent to an AWS service as part of a request to set an
access control policy.
A JSON string representation of this AWS access control policy.
Parses a JSON document of a policy and creates a Policy object.
JSON document of a policy.
Gets and Sets the policy ID for this policy. Policy IDs serve to help
developers keep track of multiple policies, and are often used as human
readable name for a policy.
Gets the version of this AWS policy.
Gets and Sets the collection of statements contained by this policy. Individual
statements in a policy are what specify the rules that enable or disable
access to your AWS resources.
Sets an attribute of a queue. Currently, you can set only one attribute per request.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
A list of messages associated with the ReceiveMessageRequest.
Checks if Message property is set
true if Message property is set
Gets and sets the Message property.
An element containing the information about the message.
Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable hosted queue for storing
messages as they travel between computers. By using Amazon SQS, developers can simply move data between
distributed application components performing different tasks, without losing messages or requiring each
component to be always available. Amazon SQS works by exposing Amazon's web-scale messaging infrastructure
as a web service. Any computer on the Internet can add or read messages without any installed software or
special firewall configurations. Components of applications using Amazon SQS can run independently, and do
not need to be on the same network, developed with the same technologies, or running at the same time.
Create Queue
Create Queue request
Create Queue Response from the service
The CreateQueue action creates a new queue, or returns the URL of an existing one.
When you request CreateQueue, you provide a name for the queue. To successfully create
a new queue, you must provide a name that is unique within the scope of your own queues.
If you provide the name of an existing queue, a new queue isn't created and an error
isn't returned. Instead, the request succeeds and the queue URL for the existing queue is
returned. Exception: if you provide a value for DefaultVisibilityTimeout that is different
from the value for the existing queue, you receive an error.
List Queues
List Queues request
List Queues Response from the service
The ListQueues action returns a list of your queues.
Add Permission
Add Permission request
Add Permission Response from the service
Adds the specified permission(s) to a queue for the specified principal(s). This allows for sharing access to the queue.
Change Message Visibility
Change Message Visibility request
Change Message Visibility Response from the service
The ChangeMessageVisibility action extends the read lock timeout of the specified message from the specified queue to the specified value.
Delete Message
Delete Message request
Delete Message Response from the service
The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.
Delete Queue
Delete Queue request
Delete Queue Response from the service
This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.
Get Queue Attributes
Get Queue Attributes request
Get Queue Attributes Response from the service
Gets one or all attributes of a queue. Queues currently have two attributes you can get: ApproximateNumberOfMessages and VisibilityTimeout.
Remove Permission
Remove Permission request
Remove Permission Response from the service
Removes the permission with the specified statement id from the queue.
Receive Message
Receive Message request
Receive Message Response from the service
Retrieves one or more messages from the specified queue. For each message returned, the response includes
the message body; MD5 digest of the message body; receipt handle, which is the identifier you must provide
when deleting the message; and message ID of each message. Messages returned by this action stay in the queue
until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned
on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a
VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.
Send Message
Send Message request
Send Message Response from the service
The SendMessage action delivers a message to the specified queue.
Set Queue Attributes
Set Queue Attributes request
Set Queue Attributes Response from the service
Sets an attribute of a queue. Currently, you can set only the VisibilityTimeout attribute for a queue.
Removes a statement from a topic's access control policy.
Sets the TopicArn property
The Amazon Reference Name (ARN) of the topic whose access control policy the
client wishes to modify.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the Label property
The unique label of the statement the client wishes to remove.
this instance
Checks if Label property is set
true if Label property is set
Gets and sets the TopicArn property.
The Amazon Reference Name (ARN) of the topic whose access control policy the
client wishes to modify.
Gets and sets the Label property.
The unique label of the statement the client wishes to remove.
Encapsulates the result of the ListTopics action.
Checks if Topics property is set
true if Topics property is set
Checks if NextToken property is set
true if NextToken property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Topics property.
A list of topic ARNs.
Gets and sets the NextToken property.
Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
Encapsulates the metadata and result of the ListTopics action.
Checks if ListTopicsResult property is set
true if ListTopicsResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ListTopicsResult property.
Encapsulates the result of the ListTopics action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
The ConfirmSubscription action verifies an endpoint owner's intent to
receive messages by validating the token sent to the endpoint by an
earlier Subscribe action. If the token is valid, the action creates
a new subscription and returns its Amazon Resource Name (ARN). This
call requires an AWS signature only when the AuthenticateOnUnsubscribe
flag is set to "true".
Sets the TopicArn property
The ARN of the topic for which you wish to confirm a subscription.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the Token property
Short-lived token sent to an endpoint during the Subscribe action.
this instance
Checks if Token property is set
true if Token property is set
Sets the AuthenticateOnUnsubscribe property
Indicates that you want to disable unauthenticated unsubsciption of the subscription.
If parameter is present in the request, the request has an AWS signature, and the value
of this parameter is true, only the topic owner and the subscription owner will be
permitted to unsubscribe the endopint, and the Unsubscribe action will require AWS
authentication.
this instance
Checks if AuthenticateOnUnsubscribe property is set
true if AuthenticateOnUnsubscribe property is set
Gets and sets the TopicArn property.
The ARN of the topic for which you wish to confirm a subscription.
Gets and sets the Token property.
Short-lived token sent to an endpoint during the Subscribe action.
Gets and sets the AuthenticateOnUnsubscribe property.
Indicates that you want to disable unauthenticated unsubsciption of the subscription.
If parameter is present in the request, the request has an AWS signature, and the value
of this parameter is true, only the topic owner and the subscription owner will be
permitted to unsubscribe the endopint, and the Unsubscribe action will require AWS
authentication.
Encapsulates the metadata and result of the AddPermission action.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
Returns information about the VerifyEmailAddress response metadata.
The VerifyEmailAddress operation has a void result type.
Verify Email Address Request Marshaller
Container for the parameters to the GetSendStatistics operation.
Returns the user's sending statistics. The result is a list of
data points, representing the last two weeks of sending
activity. Each data point in the list contains statistics
for a 15-minute interval.
Returns all of the attributes associated with the item. Optionally, the attributes returned can
be limited to one or more specified attribute name parameters. If the item does not exist on the
replica that was accessed for this operation, an empty set is returned. The system does not return
an error as it cannot guarantee the item does not exist on other replicas.
Sets the Attribute property
Attribute associated with an Item.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the Attribute property.
Attribute associated with an Item.
Returns information about the domain, including when the domain was created, the number of items and
attributes, and the size of attribute names and values.
Sets the ItemCount property
The number of all items in the domain.
this instance
Checks if ItemCount property is set
true if ItemCount property is set
Sets the ItemNamesSizeBytes property
The total size of all item names in the domain, in bytes.
this instance
Checks if ItemNamesSizeBytes property is set
true if ItemNamesSizeBytes property is set
Sets the AttributeNameCount property
The number of unique attribute names in the domain.
this instance
Checks if AttributeNameCount property is set
true if AttributeNameCount property is set
Sets the AttributeNamesSizeBytes property
The total size of all unique attribute names, in bytes.
this instance
Checks if AttributeNamesSizeBytes property is set
true if AttributeNamesSizeBytes property is set
Sets the AttributeValueCount property
The number of all attribute name/value pairs in the domain.
this instance
Checks if AttributeValueCount property is set
true if AttributeValueCount property is set
Sets the AttributeValuesSizeBytes property
The total size of all attribute values, in bytes.
this instance
Checks if AttributeValuesSizeBytes property is set
true if AttributeValuesSizeBytes property is set
Sets the Timestamp property
The data and time when metadata was calculated in Epoch (UNIX) time.
this instance
Checks if Timestamp property is set
true if Timestamp property is set
Gets and sets the ItemCount property.
The number of all items in the domain.
Gets and sets the ItemNamesSizeBytes property.
The total size of all item names in the domain, in bytes.
Gets and sets the AttributeNameCount property.
The number of unique attribute names in the domain.
Gets and sets the AttributeNamesSizeBytes property.
The total size of all unique attribute names, in bytes.
Gets and sets the AttributeValueCount property.
The number of all attribute name/value pairs in the domain.
Gets and sets the AttributeValuesSizeBytes property.
The total size of all attribute values, in bytes.
Gets and sets the Timestamp property.
The data and time when metadata was calculated in Epoch (UNIX) time.
Represents a topic configuration for notification configuration. A topic configuration contains
an event and a topic arn.
Sets the Event property.
Event property
this instance
Sets the Topic property.
Topic property
this instance
Creates a string representation of a topic configuration.
The string representation of the topic configuration.
Creates a xml representation of a topic configuration.
The xml representation of the topic configuration.
Gets and sets the Event property.
Gets and sets the Topic property.
The EnableBucketLoggingRequest contains the parameters used for the EnableBucketLogging operation.
Required Parameters: BucketName, LoggingConfig
Sets the BucketName property for this request.
This is the S3 Bucket that you want to enable logging.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the LoggingConfig property for this request.
This config declares all of the logging configuration properties.
The value that LoggingConfig is set to
the request with the LoggingConfig set
Checks if LoggingConfig property is set.
true if LoggingConfig property is set.
Gets and sets the BucketName property.
Gets and sets the LoggingConfig property.
The DeleteBucketWebsiteResponse contains any headers returned by S3.
The DeleteBucketPolicyResponse contains any headers returned by S3.
Revoke D B Security Group Ingress Request Marshaller
Describe D B Engine Versions Request Marshaller
DBParameterGroupStatus Unmarshaller
Response Unmarshaller for CreateDBSecurityGroup operation
The results from the RestoreDBInstanceFromDBSnapshot action.
Gets and sets the RestoreDBInstanceFromDBSnapshotResult property.
Contains the result of a successful invocation of the RestoreDBInstanceFromDBSnapshot
action.
AmazonRDS exception
Constructs a new PointInTimeRestoreNotEnabledException with the specified error
message.
Describes the error encountered.
The results from the ModifyDBInstance action.
Gets and sets the ModifyDBInstanceResult property.
Contains the result of a successful invocation of the ModifyDBInstance
action.
Container for the parameters to the DescribeDBParameters operation.
Returns the detailed parameter list for a particular DBParameterGroup.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the Source property
The value to set for the Source property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The name of a specific database parameter group to return details for. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
AmazonRDS exception
Constructs a new DBParameterGroupAlreadyExistsException with the specified error
message.
Describes the error encountered.
Returns information about the CreateDBSnapshot response and response metadata.
Gets and sets the CreateDBSnapshotResult property.
Contains the result of a successful invocation of the CreateDBSnapshot
action.
The results from the CreateDBInstanceReadReplica action.
Gets and sets the CreateDBInstanceReadReplicaResult property.
Contains the result of a successful invocation of the CreateDBInstanceReadReplica
action.
Interface for accessing AmazonImportExport.
AWS Import/Export Service AWS Import/Export accelerates
transferring large amounts of data between the AWS cloud and portable
storage devices that you mail to us. AWS Import/Export transfers data
directly onto and off of your storage devices using Amazon's
high-speed internal network and bypassing the Internet. For large data
sets, AWS Import/Export is often faster than Internet transfer and
more cost effective than upgrading your connectivity.
This operation initiates the process of scheduling an upload or
download of your data. You include in the request a manifest that
describes the data transfer specifics. The response to the request
includes a job ID, which you can use in other operations, a signature
that you use to identify your storage device, and the address where
you should ship your storage device.
Container for the necessary parameters
to execute the CreateJob service method on AmazonImportExport.
The response from the CreateJob service method, as returned
by AmazonImportExport.
This operation cancels a specified job. Only the job owner can
cancel it. The operation fails if the job has already started or is
complete.
Container for the necessary parameters
to execute the CancelJob service method on AmazonImportExport.
The response from the CancelJob service method, as returned
by AmazonImportExport.
This operation returns information about a job, including where
the job is in the processing pipeline, the status of the results, and
the signature value associated with the job. You can only return
information about jobs you own.
Container for the necessary parameters
to execute the GetStatus service method on AmazonImportExport.
The response from the GetStatus service method, as returned
by AmazonImportExport.
This operation returns the jobs associated with the requester.
AWS Import/Export lists the jobs in reverse chronological order based
on the date of creation. For example if Job Test1 was created
2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation
would return Test2 followed by Test1.
Container for the necessary parameters
to execute the ListJobs service method on AmazonImportExport.
The response from the ListJobs service method, as returned by
AmazonImportExport.
You use this operation to change the parameters specified in
the original manifest file by supplying a new manifest file. The
manifest file attached to this request replaces the original manifest
file. You can only use the operation after a CreateJob request but
before the data transfer starts and you can only use it on jobs you
own.
Container for the necessary parameters
to execute the UpdateJob service method on AmazonImportExport.
The response from the UpdateJob service method, as returned
by AmazonImportExport.
Container for the parameters to the UpdateServerCertificate operation.
Updates the name and/or the path of the specified server
certificate. IMPORTANT: You should understand the
implications of changing a server certificate's path or name. For more
information, see Managing Server Certificates in Using AWS Identity
and Access Management. NOTE:To change a server
certificate name the requester must have appropriate permissions on
both the source object and the target object. For example, to change
the name from ProductionCert to ProdCert, the entity making the
request must have permission on ProductionCert and ProdCert, or must
have permission on all (*). For more information about permissions,
see Permissions and Policies.
Sets the ServerCertificateName property
The value to set for the ServerCertificateName property
this instance
Sets the NewPath property
The value to set for the NewPath property
this instance
Sets the NewServerCertificateName property
The value to set for the NewServerCertificateName property
this instance
The name of the server certificate that you want to update.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The new path for the server certificate. Include this only if you are updating the server certificate's path.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
The new name for the server certificate. Include this only if you are updating the server certificate's name.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Response Unmarshaller for RemoveUserFromGroup operation
Group Unmarshaller
Response Unmarshaller for GetServerCertificate operation
Get Group Request Marshaller
Delete Signing Certificate Request Marshaller
Deactivate M F A Device Request Marshaller
CreateLoginProfileResult Unmarshaller
Response Unmarshaller for CreateAccessKey operation
The SigningCertificate data type contains information about an
X.509 signing certificate. This data type is used as a
response element in the actions UploadSigningCertificate and
ListSigningCertificates.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the CertificateId property
The value to set for the CertificateId property
this instance
Sets the CertificateBody property
The value to set for the CertificateBody property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the UploadDate property
The value to set for the UploadDate property
this instance
Name of the User the signing certificate is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The ID for the signing certificate.
Constraints:
-
Length
24 - 128
-
Pattern
[\w]*
The contents of the signing certificate.
Constraints:
-
Length
1 - 16384
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.
Constraints:
-
Allowed Values
Active, Inactive
The date when the signing certificate was uploaded.
Returns information about the ListUserPoliciesResult response and response metadata.
Gets and sets the ListUserPoliciesResult property.
Contains the result of a successful invocation of the ListUserPolicies action.
AmazonIdentityManagementService exception
Constructs a new KeyPairMismatchException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the
GetServerCertificate action.
Sets the ServerCertificate property
The value to set for the ServerCertificate property
this instance
Information about the server certificate.
Container for the parameters to the DeleteAccessKey operation.
Deletes the access key associated with the specified
User. If you do not specify a User name, IAM determines
the User name implicitly based on the AWS Access Key ID signing the
request. Because this action works for access keys under the AWS
Account, you can use this API to manage root credentials even if the
AWS Account has no associated Users.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the AccessKeyId property
The value to set for the AccessKeyId property
this instance
Name of the User whose key you want to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The Access Key ID for the Access Key ID and Secret Access Key you want to delete.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
Returns information about the CreateLoginProfileResult response and response metadata.
Gets and sets the CreateLoginProfileResult property.
Contains the result of a successful invocation of the CreateLoginProfile action.
Policies Unmarshaller
Deregister Instances From Load Balancer Request Marshaller
Response Unmarshaller for DeleteLoadBalancer operation
DeleteLoadBalancerPolicyResult Unmarshaller
Response Unmarshaller for DeleteLoadBalancerPolicy operation
Response Unmarshaller for DeleteLoadBalancerListeners operation
Returns information about the DisableAvailabilityZonesForLoadBalancerResult response and response metadata.
Gets and sets the DisableAvailabilityZonesForLoadBalancerResult property.
The output for the DisableAvailabilityZonesForLoadBalancer action.
Container for the parameters to the DisableAvailabilityZonesForLoadBalancer operation.
Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer. There
must be at least one Availability Zone registered with a LoadBalancer at all times. A client cannot remove all the Availability Zones from a
LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability
Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its
remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide
the same account credentials as those that were used to create the LoadBalancer.
Default constructor for a new DisableAvailabilityZonesForLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DisableAvailabilityZonesForLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of Availability Zones to be removed from the LoadBalancer. There must be at least one
Availability Zone registered with a LoadBalancer at all times. The client cannot remove all the Availability Zones from a LoadBalancer.
Specified Availability Zones must be in the same Region.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of Availability Zones to be removed from the LoadBalancer. There must be at least one Availability Zone registered with a
LoadBalancer at all times. The client cannot remove all the Availability Zones from a LoadBalancer. Specified Availability Zones must be in
the same Region.
Update Environment Request Marshaller
Listener Unmarshaller
CreateEnvironmentResult Unmarshaller
CreateApplicationVersionResult Unmarshaller
AmazonElasticBeanstalk exception
Constructs a new TooManyEnvironmentsException with the specified error
message.
Describes the error encountered.
AmazonElasticBeanstalk exception
Constructs a new TooManyBucketsException with the specified error
message.
Describes the error encountered.
A specification of a location in Amazon S3.
Sets the S3Bucket property
The value to set for the S3Bucket property
this instance
Sets the S3Key property
The value to set for the S3Key property
this instance
The Amazon S3 bucket where the data is located.
Constraints:
-
Length
0 - 255
The Amazon S3 key where the data is located.
Constraints:
-
Length
0 - 1024
Describes an Auto Scaling launch configuration.
Sets the Name property
The value to set for the Name property
this instance
The name of the launch configuration.
Describes the AWS resources in use by this environment. This data is not live data.
Sets the LoadBalancer property
The value to set for the LoadBalancer property
this instance
Describes the LoadBalancer.
Describes the settings for a specified configuration set.
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Adds elements to the Options collection
The values to add to the Options collection
this instance
Adds elements to the Options collection
The values to add to the Options collection
this instance
The name of the solution stack these configuration options belong to.
Constraints:
-
Length
0 - 100
A list of ConfigurationOptionDescription.
Returns information about the CreateStorageLocationResult response and response metadata.
Gets and sets the CreateStorageLocationResult property.
Results of a CreateStorageLocationResult call.
This class represents S3 upload policy. Policy string
representaion and signature to be used within EC2 bundling API.
S3 Upload policy to be used by EC2 API.
Access Key Id of the signer of the policy
Secret Key of the signer of the policy
Bucket name to upload
Prefix for the object keys
Expire, minutes from now
S3 Upload policy to be used by EC2 API.
Secret Key of the signer of the policy
Bucket name to upload
Prefix for the object keys
Expire, minutes from now
Base64 representation of the serialized policy.
Use policy generated by this method
for passing to EC2 bunding calls.
Base64 policy
Policy signature in base64 format
Use signature generated by this method
for passing to EC2 bunding calls along with policy.
Base64 signature
Unmonitor Instances Result
Checks if InstanceMonitoring property is set
true if InstanceMonitoring property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the InstanceMonitoring property.
Instance monitoring information
Shuts down one or more instances. This operation
is idempotent; if you
terminate an instance more than once, each
call will succeed.
Terminated instances will remain visible after
termination (approximately one hour).
Sets the InstanceId property
Instance ID to terminate.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
Instance ID to terminate.
Storage
Sets the S3 property
S3 Storage
this instance
Checks if S3 property is set
true if S3 property is set
Gets and sets the S3 property.
S3 Storage
Modify Snapshot Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Represents the capacity that a license is able to support.
Sets the Capacity property
The number of licenses available.
this instance
Checks if Capacity property is set
true if Capacity property is set
Sets the InstanceCapacity property
The number of Amazon EC2 instances that can be
supported with the
license's capacity.
this instance
Checks if InstanceCapacity property is set
true if InstanceCapacity property is set
Sets the State property
The state of this license capacity,
indicating
whether the license is actively being used or not.
this instance
Checks if State property is set
true if State property is set
Sets the EarliestAllowedDeactivationTime property
The earliest allowed time at which a license
can be deactivated.
Some licenses have time restrictions on when
they can be activated and reactivated.
this instance
Checks if EarliestAllowedDeactivationTime property is set
true if EarliestAllowedDeactivationTime property is set
Gets and sets the Capacity property.
The number of licenses available.
Gets and sets the InstanceCapacity property.
The number of Amazon EC2 instances that can be
supported with the
license's capacity.
Gets and sets the State property.
The state of this license capacity,
indicating
whether the license is actively being used or not.
Gets and sets the EarliestAllowedDeactivationTime property.
The earliest allowed time at which a license
can be deactivated.
Some licenses have time restrictions on when
they can be activated and reactivated.
Get Password Data Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if GetPasswordDataResult property is set
true if GetPasswordDataResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the GetPasswordDataResult property.
Get Password Data Result
Error
Sets the Type property
Type of error
this instance
Checks if Type property is set
true if Type property is set
Sets the Code property
Error code
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
Error message
this instance
Checks if Message property is set
true if Message property is set
Sets the Detail property
Details
this instance
Checks if Detail property is set
true if Detail property is set
Gets and sets the Type property.
Type of error
Gets and sets the Code property.
Error code
Gets and sets the Message property.
Error message
Gets and sets the Detail property.
Details
Describe Vpn Connections Result
Checks if VpnConnection property is set
true if VpnConnection property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the VpnConnection property.
List of vpn connections
The Result of the Describe Spot Instances
operation.
Checks if SpotInstanceRequest property is set
true if SpotInstanceRequest property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SpotInstanceRequest property.
A list of the SpotInstanceRequest objects
returned by the service.
Describes Reserved Instance offerings that are
available for purchase. With Amazon EC2
Reserved Instances, you
purchase the right to launch Amazon EC2 instances
for a period of time (without getting
insufficient capacity errors) and pay a
lower usage rate for the
actual time used. For more information
about Reserved Instances, go to the Amazon
Elastic Compute Cloud Developer Guide.
Sets the ReservedInstancesId property
ID of the Reserved Instances to describe.
this instance
Checks if ReservedInstancesId property is set
true if ReservedInstancesId property is set
Sets the InstanceType property
The instance type on which the Reserved
Instance can be used.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the AvailabilityZone property
The Availability Zone in which the Reserved
Instance can be used.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the ProductDescription property
The Reserved Instance description.
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags
associated with the specified ReservedInstances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the ReservedInstancesId property.
ID of the Reserved Instances to describe.
Gets and sets the InstanceType property.
The instance type on which the Reserved
Instance can be used.
Gets and sets the AvailabilityZone property.
The Availability Zone in which the Reserved
Instance can be used.
Gets and sets the ProductDescription property.
The Reserved Instance description.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags
associated with the specified ReservedInstances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
The Response for the
DescribeNetworkAcls operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeNetworkAclsResult property is set
true if DescribeNetworkAclsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeNetworkAclsResult property.
DescribeNetworkAcls Result
Describe Key Pairs Result
Checks if KeyPair property is set
true if KeyPair property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the KeyPair property.
List of key pairs
Describe Dhcp Options Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeDhcpOptionsResult property is set
true if DescribeDhcpOptionsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeDhcpOptionsResult property.
Describe Dhcp Options Result
Delete Volume Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Deletes an ingress or egress entry (i.e., rule) from a network ACL. For more information about network
ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.
Sets the NetworkAclId property
ID of the network ACL.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the RuleNumber property
Rule number for the entry to delete.
this instance
Checks if RuleNumber property is set
true if RuleNumber property is set
Sets the Egress property
Whether the rule to delete is an egress rule (true) or
ingress rule (false).
this instance
Checks if Egress property is set
true if Egress property is set
Gets and sets the NetworkAclId property.
ID of the network ACL.
Gets and sets the RuleNumber property.
Rule number for the entry to delete.
Gets and sets the Egress property.
Whether the rule to delete is an egress rule (true) or
ingress rule (false).
Creat Volume Permission
Sets the UserId property
User ID of a user that can create volumes from
the snapshot.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the GroupName property
Group that is allowed to create volumes from
the snapshot (currently supports "all").
this instance
Checks if GroupName property is set
true if GroupName property is set
Gets and sets the UserId property.
User ID of a user that can create volumes from
the snapshot.
Gets and sets the GroupName property.
Group that is allowed to create volumes from
the snapshot (currently supports "all").
The Response for the
CreateTagsResponse operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Creates a new security group. Group names must be
unique per account.
Every instance is launched in a security group.
If no security group is specified during launch,
the instances are launched in the default security group.
Instances within the same security group have unrestricted network
access to each other. Instances will reject network access attempts from
other instances in a different security group. As the owner of instances you
can grant or revoke specific permissions using the
AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress
operations
Sets the GroupId property
Id of the standard (EC2) or VPC security group to modify. Conditional
The group must belong to your account.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
Name of the security group.
Constraints:
Accepts alphanumeric characters, spaces, dashes, and
underscores.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the GroupDescription property
Description of the group.
Constraints: Accepts
alphanumeric characters, spaces, dashes, and
underscores.
this instance
Checks if GroupDescription property is set
true if GroupDescription property is set
Sets the VpcId property
ID of the VPC.
Condition: Required for VPC security groups
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the GroupId property.
Id of the standard (EC2) or VPC security group to modify. Conditional
The group must belong to your account.
Gets and sets the GroupName property.
Name of the security group.
Constraints:
Accepts alphanumeric characters, spaces, dashes, and
underscores.
Gets and sets the GroupDescription property.
Description of the group.
Constraints: Accepts
alphanumeric characters, spaces, dashes, and
underscores.
Gets and sets the VpcId property.
ID of the VPC.
Condition: Required for VPC security groups
Creates a PlacementGroup into which multiple Amazon EC2
instances can be launched. Users must give the group a
name unique within the scope of the user account.
Sets the GroupName property
The name of the PlacementGroup.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the Strategy property
The PlacementGroup strategy.
this instance
Checks if Strategy property is set
true if Strategy property is set
Gets and sets the GroupName property.
The name of the PlacementGroup.
Gets and sets the Strategy property.
The PlacementGroup strategy.
CreateInternetGateway Result
Checks if InternetGateway property is set
true if InternetGateway property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the InternetGateway property.
Information about the Internet gateway
Create Customer Gateway Result
Checks if CustomerGateway property is set
true if CustomerGateway property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CustomerGateway property.
Customer gateway
Bundle Task
Sets the InstanceId property
Instance associated with this bundle task.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the BundleId property
Identifier for this task.
this instance
Checks if BundleId property is set
true if BundleId property is set
Sets the BundleState property
The state of the task.
Valid Values: pending |
waiting-for-shutdown | storing | canceling |
complete | failed
this instance
Checks if BundleState property is set
true if BundleState property is set
Sets the StartTime property
The time this task started.
this instance
Checks if StartTime property is set
true if StartTime property is set
Sets the UpdateTime property
The time of the most recent update for the
task.
this instance
Checks if UpdateTime property is set
true if UpdateTime property is set
Sets the Storage property
Amazon S3 storage locations.
this instance
Checks if Storage property is set
true if Storage property is set
Sets the Progress property
The level of task completion, in percent
(e.g., 20%).
this instance
Checks if Progress property is set
true if Progress property is set
Sets the BundleTaskError property
If the task fails, a description of the error.
this instance
Checks if BundleTaskError property is set
true if BundleTaskError property is set
Gets and sets the InstanceId property.
Instance associated with this bundle task.
Gets and sets the BundleId property.
Identifier for this task.
Gets and sets the BundleState property.
The state of the task.
Valid Values: pending |
waiting-for-shutdown | storing | canceling |
complete | failed
Gets and sets the StartTime property.
The time this task started.
Gets and sets the UpdateTime property.
The time of the most recent update for the
task.
Gets and sets the Storage property.
Amazon S3 storage locations.
Gets and sets the Progress property.
The level of task completion, in percent
(e.g., 20%).
Gets and sets the BundleTaskError property.
If the task fails, a description of the error.
Attach VpnGateway Result
Checks if VpcAttachment property is set
true if VpcAttachment property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the VpcAttachment property.
VPC Attachment
Acquires an elastic IP address for use with your account.
Sets the Domain property
Set to vpc to allocate the address to your VPC.
Default: Address is standard (allocated to EC2)
Valid Values: vpc | standard
Condition: Required when allocating an address to a VPC
this instance
Checks if Domain property is set
true if Domain property is set
Gets and sets the Domain property.
Set to vpc to allocate the address to your VPC.
Default: Address is standard (allocated to EC2)
Valid Values: vpc | standard
Condition: Required when allocating an address to a VPC
Amazon EC2 Exception provides details of errors
returned by Amazon EC2 service
Initializes a new AmazonEC2Exception with default values.
Initializes a new AmazonEC2Exception with a specified
error message
A message that describes the error
Initializes a new AmazonEC2Exception with a specified error message
and HTTP status code
A message that describes the error
HTTP status code for error response
Initializes a new AmazonEC2Exception from the inner exception that is
the cause of this exception.
The nested exception that caused the AmazonEC2Exception
Initializes a new AmazonEC2Exception with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Serializes this instance of AmazonEC2Exception.
The object that holds the serialized object data.
The contextual information about the source or destination.
Constructs AmazonEC2Exception with message and wrapped exception
A message that describes the error
The nested exception that caused the AmazonS3Exception
Initializes an AmazonEC2Exception with error information provided in an
AmazonEC2 response.
A message that describes the error
HTTP status code for error response
Error Code returned by the service
Error type. Possible types: Sender, Receiver or Unknown
Request ID returned by the service
Compete xml found in response
Gets and sets of the ErrorCode property.
Gets and sets of the ErrorType property.
Gets error message
Gets status code returned by the service if available. If status
code is set to -1, it means that status code was unavailable at the
time exception was thrown
Gets XML returned by the service if available.
Gets Request ID returned by the service if available.
Put Metric Data Request Marshaller
List Metrics Request Marshaller
Disable Alarm Actions Request Marshaller
AmazonCloudWatch exception
Constructs a new InvalidFormatException with the specified error
message.
Describes the error encountered.
The SetOriginAccessIdentityConfigResponse contains the Origin Access Identity's modified
information structure along with any other headers returned by
CloudFront.
Gets and sets the ETag property.
The Distribution's ETag is also set if
possible.
The GetStreamingDistributionInfoResponse contains all the information about the
GetStreamingDistributionInfo operation and any headers returned by CloudFront.
Gets and sets the StreamingDistribution property.
This contains all the information (including the configuration) for a
cloudfront StreamingDistribution.
Gets and sets the ETag property.
The Streaming Distribution's ETag is also set if
possible.
The CreateDistributionResponse contains any headers and the Distribution Config
for the distribution created.
Gets and sets the Distribution property.
Gets and sets the ETag property.
The Distribution's ETag is also set if
possible.
The CreateStreamingDistributionResponse contains any headers and the StreamingDistribution Config
for the distribution created.
Gets and sets the StreamingDistribution property.
Gets and sets the ETag property.
The Streaming Distribution's ETag is also set if
possible.
Describes a CloudFront Streaming Distribution.
It is used as a response element when Creating a Distribution and Getting a Distribution's Information.
A distribution consists of the following items:
- Id
- Status
- Last Modified Timestamp
- Domain Name
- The Configuration for the Distribution
For more information, please visit:
The DistributionBase contains the common elements of a CloudFront distribution.
The shared elements are:
- Id
- Status
- Last Modified Timestamp
- Domain Name
- The Configuration for the Distribution
For more information, please visit:
-
-
Checks if Id property is set.
true if Id property is set.
Checks if Status property is set.
true if Status property is set.
Checks if LastModifiedTime property is set.
true if LastModifiedTime property is set.
Checks if DomainName property is set
true if DomainName property is set
Checks if the ETag property is set.
true if ETag property is set.
Checks if ActiveTrustedSigners property is set.
true if ActiveTrustedSigners property is set.
Returns the string representation of the distribution.
A string representing the distribution
Gets and sets the Id property. This is the Id returned by CloudFront
when the distribution is created and is unique to the Distribution.
Gets and sets the Status property.
The current status of the Distribution can either be Deployed or In Progres
Gets and sets the LastModifiedTime property.
The date and time the distribution was last modified. The
string returned is the GMT representation of DateTime.
The date is in the format YYYY-MM-DDThh:mm:ssZ, as specified in the
ISO 8601 standard (e.g., 2008-07-24T19:37:58Z)
Gets and sets the DomainName property.
The domain name corresponding to the distribution. For example,
e604721fxaaqy9.cloudfront.net.
Gets and sets the ETag property of this
Distribution's information.
Gets and sets the ActiveTrustedSigners property.
This specifies any AWS accounts you want to permit to create signed URLs for private content.
Checks if StreamingDistributionConfig property is set
true if StreamingDistributionConfig property is set
Gets and sets the Streaming Distribution's Configuration.
Response Unmarshaller for GetTemplate operation
Create Stack Request Marshaller
Returns information about the ListStackResourcesResult response and response metadata.
Gets and sets the ListStackResourcesResult property.
The output for a ListStackResources action.
The output for a DescribeStackResources action.
Adds elements to the StackResources collection
The values to add to the StackResources collection
this instance
Adds elements to the StackResources collection
The values to add to the StackResources collection
this instance
A list of StackResource structures.
SuspendedProcess Unmarshaller
ScalingPolicy Unmarshaller
Response Unmarshaller for DescribeScalingActivities operation
Describe Scaling Activities Request Marshaller
Response Unmarshaller for DescribeLaunchConfigurations operation
Response Unmarshaller for DeleteLaunchConfiguration operation
AutoScalingGroup Unmarshaller
Alarm Unmarshaller
Container for the parameters to the ResumeProcesses operation.
Resumes Auto Scaling processes for an Auto Scaling group. For more information, see SuspendProcesses and ProcessType.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the ScalingProcesses collection
The values to add to the ScalingProcesses collection
this instance
Adds elements to the ScalingProcesses collection
The values to add to the ScalingProcesses collection
this instance
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The processes that you want to suspend or resume, which can include one or more of the following: - Launch
- Terminate
- HealthCheck
- ReplaceUnhealthy
- AZRebalance
- AlarmNotifications
- ScheduledActions
To suspend
all process types, omit this parameter.
The LaunchConfiguration data type.
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Sets the LaunchConfigurationARN property
The value to set for the LaunchConfigurationARN property
this instance
Sets the ImageId property
The value to set for the ImageId property
this instance
Sets the KeyName property
The value to set for the KeyName property
this instance
Adds elements to the SecurityGroups collection
The values to add to the SecurityGroups collection
this instance
Adds elements to the SecurityGroups collection
The values to add to the SecurityGroups collection
this instance
Sets the UserData property
The value to set for the UserData property
this instance
Sets the InstanceType property
The value to set for the InstanceType property
this instance
Sets the KernelId property
The value to set for the KernelId property
this instance
Sets the RamdiskId property
The value to set for the RamdiskId property
this instance
Adds elements to the BlockDeviceMappings collection
The values to add to the BlockDeviceMappings collection
this instance
Adds elements to the BlockDeviceMappings collection
The values to add to the BlockDeviceMappings collection
this instance
Sets the InstanceMonitoring property
The value to set for the InstanceMonitoring property
this instance
Sets the CreatedTime property
The value to set for the CreatedTime property
this instance
Specifies the name of the launch configuration.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The launch configuration's Amazon Resource Name (ARN).
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Provides the name of the EC2 key pair.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A description of the security groups to associate with the EC2 instances.
The user data available to the launched EC2 instances.
Constraints:
-
Length
0 - 21847
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the instance type of the EC2 instance.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Provides the ID of the kernel associated with the EC2 AMI.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Provides ID of the RAM disk associated with the EC2 AMI.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.
Controls whether instances in this group are launched with detailed monitoring or not.
Provides the creation date and time for this launch configuration.
The Instance data type.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the LifecycleState property
The value to set for the LifecycleState property
this instance
Sets the HealthStatus property
The value to set for the HealthStatus property
this instance
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Specifies the EC2 instance ID.
Constraints:
-
Length
1 - 16
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Availability zones associated with this instance.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Contains a description of the current lifecycle state.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The instance's health status.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The launch configuration associated with this instance.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Implemenation for accessing AmazonAutoScaling.
Auto Scaling Auto Scaling is a web service designed to automatically launch or terminate EC2 instances based on user-defined
policies, schedules, and health checks. Auto Scaling responds automatically to changing conditions. All you need to do is specify how it
should respond to those changes. Auto Scaling groups can work across multiple Availability Zones - distinct physical
locations for the hosted Amazon EC2 instances - so that if an Availability Zone becomes unavailable, Auto Scaling will automatically
redistribute applications to a different Availability Zone. Every API call returns a response meta data object that contains
a request identifier. Successful requests return an HTTP 200 status code. Unsuccessful requests return an error object and an HTTP status
code of 400 or 500. The current WSDL is available at:
http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl Endpoints For information about this
product's regions and endpoints, go to Regions and Endpoints in the Amazon Web Services General Reference.
Interface for accessing AmazonAutoScaling.
Auto Scaling Auto Scaling is a web service designed to automatically launch or terminate EC2 instances based on user-defined
policies, schedules, and health checks. Auto Scaling responds automatically to changing conditions. All you need to do is specify how it
should respond to those changes. Auto Scaling groups can work across multiple Availability Zones - distinct physical
locations for the hosted Amazon EC2 instances - so that if an Availability Zone becomes unavailable, Auto Scaling will automatically
redistribute applications to a different Availability Zone. Every API call returns a response meta data object that contains
a request identifier. Successful requests return an HTTP 200 status code. Unsuccessful requests return an error object and an HTTP status
code of 400 or 500. The current WSDL is available at:
http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl Endpoints For information about this
product's regions and endpoints, go to Regions and Endpoints in the Amazon Web Services General Reference.
Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of
the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. This action
supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned
token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeAutoScalingGroups service
method on AmazonAutoScaling.
The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled
metrics with the Metrics parameter. Auto scaling metrics collection can be turned on only if the
InstanceMonitoring.Enabled flag, in the Auto Scaling group's launch configuration, is set to true .
Container for the necessary parameters to execute the EnableMetricsCollection service method on
AmazonAutoScaling.
Resumes Auto Scaling processes for an Auto Scaling group. For more information, see SuspendProcesses and ProcessType.
Container for the necessary parameters to execute the ResumeProcesses service method on
AmazonAutoScaling.
Deletes the specified LaunchConfiguration. The specified launch configuration must not be attached to an Auto Scaling
group. Once this call completes, the launch configuration is no longer available for use.
Container for the necessary parameters to execute the DeleteLaunchConfiguration service
method on AmazonAutoScaling.
Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more
records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Container for the necessary parameters to execute the DescribePolicies service method on
AmazonAutoScaling.
The response from the DescribePolicies service method, as returned by AmazonAutoScaling.
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
Container for the necessary parameters to execute the DescribeScalingProcessTypes service
method on AmazonAutoScaling.
The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.
Creates a new Auto Scaling group with the specified name. Once the creation request is completed, the AutoScalingGroup is ready to be
used in other calls. NOTE: The Auto Scaling group name must be unique within the scope of your AWS account, and under
the quota of Auto Scaling groups allowed for your account.
Container for the necessary parameters to execute the CreateAutoScalingGroup service method on
AmazonAutoScaling.
Returns the scaling activities for the specified Auto Scaling group. If the specified ActivityIds list is
empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress
appear first on the list. This action supports pagination. If the response includes a token, there are more records
available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeScalingActivities service
method on AmazonAutoScaling.
The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.
Returns a list of notification actions associated with Auto Scaling groups for specified events.
Container for the necessary parameters to execute the
DescribeNotificationConfigurations service method on AmazonAutoScaling.
The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.
Runs the policy you create for your Auto Scaling group in PutScalingPolicy.
Container for the necessary parameters to execute the ExecutePolicy service method on
AmazonAutoScaling.
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the
parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update
request.
Container for the necessary parameters to execute the PutScalingPolicy service method on
AmazonAutoScaling.
The response from the PutScalingPolicy service method, as returned by AmazonAutoScaling.
Creates a notification action for an Auto Scaling group when a specified event takes place.
Container for the necessary parameters to execute the PutNotificationConfiguration service
method on AmazonAutoScaling.
Deletes a policy created by PutScalingPolicy
Container for the necessary parameters to execute the DeletePolicy service method on
AmazonAutoScaling.
Deletes notifications created by PutNotificationConfiguration.
Container for the necessary parameters to execute the DeleteNotificationConfiguration
service method on AmazonAutoScaling.
Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
Container for the necessary parameters to execute the DeleteScheduledAction service method on
AmazonAutoScaling.
Sets the health status of an instance.
Container for the necessary parameters to execute the SetInstanceHealth service method on
AmazonAutoScaling.
Returns a list of all notification types that are supported by Auto Scaling. What if the input is empty?
Container for the necessary parameters to execute the
DescribeAutoScalingNotificationTypes service method on AmazonAutoScaling.
The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.
Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the
ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.
IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from
functioning properly. For more information about processes and their dependencies, see ProcessType. To resume processes that
have been suspended, use ResumeProcesses.
Container for the necessary parameters to execute the SuspendProcesses service method on
AmazonAutoScaling.
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full
details of all instances up to a maximum of fifty. This action supports pagination by returning a token if there are more
pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeAutoScalingInstances service
method on AmazonAutoScaling.
The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.
Creates a new launch configuration. Once created, the new launch configuration is available for immediate use.
NOTE: The launch configuration name used must be unique, within the scope of the client's AWS account, and the maximum limit of
launch configurations must not yet have been met, or else the call will fail.
Container for the necessary parameters to execute the CreateLaunchConfiguration service
method on AmazonAutoScaling.
Deletes the specified auto scaling group if the group has no instances and no scaling activities in progress.
NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and
maximum size of the AutoScalingGroup to zero.
Container for the necessary parameters to execute the DeleteAutoScalingGroup service method on
AmazonAutoScaling.
Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of
affected metrics with the Metrics parameter.
Container for the necessary parameters to execute the DisableMetricsCollection service method
on AmazonAutoScaling.
Updates the configuration for the specified AutoScalingGroup. NOTE: To update an Auto Scaling group with a
launch configuration that has the InstanceMonitoring.enabled flag set to false, you must first ensure that collection of group metrics is
disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable
collection of all group metrics by calling DisableMetricsCollection. The new settings are registered upon the completion of
this call. Any launch configuration settings take effect on any triggers after this call returns. Triggers that are currently in progress
aren't affected. NOTE: If the new values are specified for the MinSize or MaxSize parameters, then there will be an
implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the
request.
Container for the necessary parameters to execute the UpdateAutoScalingGroup service method on
AmazonAutoScaling.
Returns a full description of the launch configurations given the specified names. If no names are specified, then the
full details of all launch configurations are returned.
Container for the necessary parameters to execute the DescribeLaunchConfigurations service
method on AmazonAutoScaling.
The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.
Returns policy adjustment types for use in the PutScalingPolicy action.
Container for the necessary parameters to execute the DescribeAdjustmentTypes service method on
AmazonAutoScaling.
The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.
Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of action already executed, see
the activity record returned in DescribeScalingActivities.
Container for the necessary parameters to execute the DescribeScheduledActions service method
on AmazonAutoScaling.
The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.
Creates a scheduled scaling action for a Auto Scaling group. If you leave a parameter unspecified, the corresponding value remains
unchanged in the affected Auto Scaling group.
Container for the necessary parameters to execute the PutScheduledUpdateGroupAction
service method on AmazonAutoScaling.
Returns a list of metrics and a corresponding list of granularities for each metric.
Container for the necessary parameters to execute the DescribeMetricCollectionTypes
service method on AmazonAutoScaling.
The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.
Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not
possible to define which EC2 instances will be terminated. This applies to any auto-scaling decisions that might result in terminating
instances. There are two common use cases for SetDesiredCapacity :
one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use
cases relate to the concept of cooldown. In the first case, if you use the Auto Scaling triggering system,
SetDesiredCapacity changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for
example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject
requests to change the size of the group for that entire 10 minute period. The SetDesiredCapacity command allows you to circumvent
this restriction and change the size of the group before the end of the cooldown period. In the second case, if you write
your own triggering system, you can use SetDesiredCapacity to control the size of your Auto Scaling group. If you want the same
cooldown functionality that Auto Scaling offers, you can configure SetDesiredCapacity to honor cooldown by setting the
HonorCooldown parameter to true .
Container for the necessary parameters to execute the SetDesiredCapacity service method on
AmazonAutoScaling.
Terminates the specified instance. Optionally, the desired group size can be adjusted. NOTE: This call simply
registers a termination request. The termination of the instance cannot happen immediately.
Container for the necessary parameters to execute the
TerminateInstanceInAutoScalingGroup service method on AmazonAutoScaling.
The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AmazonAutoScaling.
Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonAutoScalingClient with AWS Access Key ID, AWS Secret Key and an
AmazonAutoScalingClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonAutoScalingClient Configuration Object
Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of
the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. This action
supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned
token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeAutoScalingGroups service
method on AmazonAutoScaling.
The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled
metrics with the Metrics parameter. Auto scaling metrics collection can be turned on only if the
InstanceMonitoring.Enabled flag, in the Auto Scaling group's launch configuration, is set to true .
Container for the necessary parameters to execute the EnableMetricsCollection service method on
AmazonAutoScaling.
Resumes Auto Scaling processes for an Auto Scaling group. For more information, see SuspendProcesses and ProcessType.
Container for the necessary parameters to execute the ResumeProcesses service method on
AmazonAutoScaling.
Deletes the specified LaunchConfiguration. The specified launch configuration must not be attached to an Auto Scaling
group. Once this call completes, the launch configuration is no longer available for use.
Container for the necessary parameters to execute the DeleteLaunchConfiguration service
method on AmazonAutoScaling.
Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more
records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Container for the necessary parameters to execute the DescribePolicies service method on
AmazonAutoScaling.
The response from the DescribePolicies service method, as returned by AmazonAutoScaling.
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
Container for the necessary parameters to execute the DescribeScalingProcessTypes service
method on AmazonAutoScaling.
The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.
Creates a new Auto Scaling group with the specified name. Once the creation request is completed, the AutoScalingGroup is ready to be
used in other calls. NOTE: The Auto Scaling group name must be unique within the scope of your AWS account, and under
the quota of Auto Scaling groups allowed for your account.
Container for the necessary parameters to execute the CreateAutoScalingGroup service method on
AmazonAutoScaling.
Returns the scaling activities for the specified Auto Scaling group. If the specified ActivityIds list is
empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress
appear first on the list. This action supports pagination. If the response includes a token, there are more records
available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeScalingActivities service
method on AmazonAutoScaling.
The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.
Returns a list of notification actions associated with Auto Scaling groups for specified events.
Container for the necessary parameters to execute the
DescribeNotificationConfigurations service method on AmazonAutoScaling.
The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.
Runs the policy you create for your Auto Scaling group in PutScalingPolicy.
Container for the necessary parameters to execute the ExecutePolicy service method on
AmazonAutoScaling.
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the
parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update
request.
Container for the necessary parameters to execute the PutScalingPolicy service method on
AmazonAutoScaling.
The response from the PutScalingPolicy service method, as returned by AmazonAutoScaling.
Creates a notification action for an Auto Scaling group when a specified event takes place.
Container for the necessary parameters to execute the PutNotificationConfiguration service
method on AmazonAutoScaling.
Deletes a policy created by PutScalingPolicy
Container for the necessary parameters to execute the DeletePolicy service method on
AmazonAutoScaling.
Deletes notifications created by PutNotificationConfiguration.
Container for the necessary parameters to execute the DeleteNotificationConfiguration
service method on AmazonAutoScaling.
Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
Container for the necessary parameters to execute the DeleteScheduledAction service method on
AmazonAutoScaling.
Sets the health status of an instance.
Container for the necessary parameters to execute the SetInstanceHealth service method on
AmazonAutoScaling.
Returns a list of all notification types that are supported by Auto Scaling. What if the input is empty?
Container for the necessary parameters to execute the
DescribeAutoScalingNotificationTypes service method on AmazonAutoScaling.
The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.
Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the
ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.
IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from
functioning properly. For more information about processes and their dependencies, see ProcessType. To resume processes that
have been suspended, use ResumeProcesses.
Container for the necessary parameters to execute the SuspendProcesses service method on
AmazonAutoScaling.
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full
details of all instances up to a maximum of fifty. This action supports pagination by returning a token if there are more
pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
Container for the necessary parameters to execute the DescribeAutoScalingInstances service
method on AmazonAutoScaling.
The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.
Creates a new launch configuration. Once created, the new launch configuration is available for immediate use.
NOTE: The launch configuration name used must be unique, within the scope of the client's AWS account, and the maximum limit of
launch configurations must not yet have been met, or else the call will fail.
Container for the necessary parameters to execute the CreateLaunchConfiguration service
method on AmazonAutoScaling.
Deletes the specified auto scaling group if the group has no instances and no scaling activities in progress.
NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and
maximum size of the AutoScalingGroup to zero.
Container for the necessary parameters to execute the DeleteAutoScalingGroup service method on
AmazonAutoScaling.
Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of
affected metrics with the Metrics parameter.
Container for the necessary parameters to execute the DisableMetricsCollection service method
on AmazonAutoScaling.
Updates the configuration for the specified AutoScalingGroup. NOTE: To update an Auto Scaling group with a
launch configuration that has the InstanceMonitoring.enabled flag set to false, you must first ensure that collection of group metrics is
disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable
collection of all group metrics by calling DisableMetricsCollection. The new settings are registered upon the completion of
this call. Any launch configuration settings take effect on any triggers after this call returns. Triggers that are currently in progress
aren't affected. NOTE: If the new values are specified for the MinSize or MaxSize parameters, then there will be an
implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the
request.
Container for the necessary parameters to execute the UpdateAutoScalingGroup service method on
AmazonAutoScaling.
Returns a full description of the launch configurations given the specified names. If no names are specified, then the
full details of all launch configurations are returned.
Container for the necessary parameters to execute the DescribeLaunchConfigurations service
method on AmazonAutoScaling.
The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.
Returns policy adjustment types for use in the PutScalingPolicy action.
Container for the necessary parameters to execute the DescribeAdjustmentTypes service method on
AmazonAutoScaling.
The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.
Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of action already executed, see
the activity record returned in DescribeScalingActivities.
Container for the necessary parameters to execute the DescribeScheduledActions service method
on AmazonAutoScaling.
The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.
Creates a scheduled scaling action for a Auto Scaling group. If you leave a parameter unspecified, the corresponding value remains
unchanged in the affected Auto Scaling group.
Container for the necessary parameters to execute the PutScheduledUpdateGroupAction
service method on AmazonAutoScaling.
Returns a list of metrics and a corresponding list of granularities for each metric.
Container for the necessary parameters to execute the DescribeMetricCollectionTypes
service method on AmazonAutoScaling.
The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.
Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not
possible to define which EC2 instances will be terminated. This applies to any auto-scaling decisions that might result in terminating
instances. There are two common use cases for SetDesiredCapacity :
one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use
cases relate to the concept of cooldown. In the first case, if you use the Auto Scaling triggering system,
SetDesiredCapacity changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for
example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject
requests to change the size of the group for that entire 10 minute period. The SetDesiredCapacity command allows you to circumvent
this restriction and change the size of the group before the end of the cooldown period. In the second case, if you write
your own triggering system, you can use SetDesiredCapacity to control the size of your Auto Scaling group. If you want the same
cooldown functionality that Auto Scaling offers, you can configure SetDesiredCapacity to honor cooldown by setting the
HonorCooldown parameter to true .
Container for the necessary parameters to execute the SetDesiredCapacity service method on
AmazonAutoScaling.
Terminates the specified instance. Optionally, the desired group size can be adjusted. NOTE: This call simply
registers a termination request. The termination of the instance cannot happen immediately.
Container for the necessary parameters to execute the
TerminateInstanceInAutoScalingGroup service method on AmazonAutoScaling.
The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AmazonAutoScaling.
Create a base ASN.1 object from a byte array.
The byte array to parse.
The base ASN.1 object represented by the byte array.
If there is a problem parsing the data.
Read a base ASN.1 object from a stream.
The stream to parse.
The base ASN.1 object represented by the byte array.
If there is a problem parsing the data.
Retrieves one or more messages from the specified queue, including the message body and message ID of each message.
Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a
ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the
VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the
queue is used for the returned messages.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the MaxNumberOfMessages property
Maximum number of messages to return. SQS never returns more messages than this value but might return fewer.
Not necessarily all the messages in the queue are returned (for more information, see the preceding note about
machine sampling). Values can be from 1 to 10. Default is 1.
this instance
Checks if MaxNumberOfMessages property is set
true if MaxNumberOfMessages property is set
Sets the VisibilityTimeout property
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved
by a ReceiveMessage request.
this instance
Checks if VisibilityTimeout property is set
true if VisibilityTimeout property is set
Sets the AttributeName property
The attribute you want to get. Valid values: All | SenderId | SentTimestamp | ApproximateReceiveCount |
ApproximateFirstReceiveTimestamp
this instance
Checks if AttributeName property is set
true if AttributeName property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the MaxNumberOfMessages property.
Maximum number of messages to return. SQS never returns more messages than this value but might return fewer.
Not necessarily all the messages in the queue are returned (for more information, see the preceding note about
machine sampling). Values can be from 1 to 10. Default is 1.
Gets and sets the VisibilityTimeout property.
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved
by a ReceiveMessage request.
Gets and sets the AttributeName property.
The attribute you want to get. Valid values: All | SenderId | SentTimestamp | ApproximateReceiveCount |
ApproximateFirstReceiveTimestamp
Error
Sets the Type property
The error type.
this instance
Checks if Type property is set
true if Type property is set
Sets the Code property
The specific error code.
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
A summary of the error.
this instance
Checks if Message property is set
true if Message property is set
Sets the Detail property
Details associated with the error.
this instance
Checks if Detail property is set
true if Detail property is set
Gets and sets the Type property.
The error type.
Gets and sets the Code property.
The specific error code.
Gets and sets the Message property.
A summary of the error.
Gets and sets the Detail property.
Details associated with the error.
Returns metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Returns metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Amazon SQS Exception provides details of errors
returned by Amazon SQS service
Initializes a new AmazonSQSException with default values.
Initializes a new AmazonSQSException with a specified
error message
A message that describes the error
Initializes a new AmazonSQSException with a specified error message
and HTTP status code
A message that describes the error
HTTP status code for error response
Initializes a new AmazonSQSException from the inner exception that is
the cause of this exception.
The nested exception that caused the AmazonSQSException
Initializes a new AmazonSQSException with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Serializes this instance of AmazonSQSException.
The object that holds the serialized object data.
The contextual information about the source or destination.
Constructs AmazonSQSException with message and wrapped exception
A message that describes the error
The nested exception that caused the AmazonS3Exception
Initializes an AmazonSQSException with error information provided in an
AmazonSQS response.
A message that describes the error
HTTP status code for error response
Error Code returned by the service
Error type. Possible types: Sender, Receiver or Unknown
Request ID returned by the service
Compete xml found in response
Gets and sets of the ErrorCode property.
Gets and sets of the ErrorType property.
Gets error message
Gets status code returned by the service if available. If status
code is set to -1, it means that status code was unavailable at the
time exception was thrown
Gets XML returned by the service if available.
Gets Request ID returned by the service if available.
A tuple associating a topic attribute's key and value.
Sets the Key property
The key in the key/value pair.
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
The value in the key/value pair.
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the Key property.
The key in the key/value pair.
Gets and sets the Value property.
The value in the key/value pair.
Represents a unique message ID returned from a successful
SendEmail request.
Sets the MessageId property
The value to set for the MessageId property
this instance
The unique message identifier returned from the SendEmail action.
Returns information about the ListVerifiedEmailAddressesResult response and response metadata.
Gets and sets the ListVerifiedEmailAddressesResult property.
Represents a list of all the email addresses verified for the current user.
Represents the user's current activity limits returned from a
successful GetSendQuota request.
Sets the Max24HourSend property
The value to set for the Max24HourSend property
this instance
Sets the MaxSendRate property
The value to set for the MaxSendRate property
this instance
Sets the SentLast24Hours property
The value to set for the SentLast24Hours property
this instance
The maximum number of emails the user is allowed to send in a 24-hour interval.
The maximum number of emails the user is allowed to send per second.
The number of emails sent during the previous 24 hours.
Container for the parameters to the DeleteVerifiedEmailAddress operation.
Deletes the specified email address from the list of verified
addresses.
Sets the EmailAddress property
The value to set for the EmailAddress property
this instance
An email address to be removed from the list of verified addreses.
The Select operation returns a set of Attributes for ItemNames that match the select expression.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items
returned per page to enforce this limit. For example, even if you ask to retrieve 2500 items, but each individual
item is 10 kB in size, the system returns 100 items and an appropriate next token so you can get the next page of results.
Operations that run longer than 5 seconds return a time-out error response or a partial or empty result set. Partial
and empty result sets contains a next token which allow you to continue the operation from where it left off.
Responses larger than one megabyte return a partial result set.
Sets the SelectResult property
The Select operation returns a set of Attributes for ItemNames that match the select expression.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items
returned per page to enforce this limit. For example, even if you ask to retrieve 2500 items, but each individual
item is 10 kB in size, the system returns 100 items and an appropriate next token so you can get the next page of results.
Operations that run longer than 5 seconds return a time-out error response or a partial or empty result set. Partial
and empty result sets contains a next token which allow you to continue the operation from where it left off.
Responses larger than one megabyte return a partial result set.
this instance
Checks if SelectResult property is set
true if SelectResult property is set
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the SelectResult property.
The Select operation returns a set of Attributes for ItemNames that match the select expression.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items
returned per page to enforce this limit. For example, even if you ask to retrieve 2500 items, but each individual
item is 10 kB in size, the system returns 100 items and an appropriate next token so you can get the next page of results.
Operations that run longer than 5 seconds return a time-out error response or a partial or empty result set. Partial
and empty result sets contains a next token which allow you to continue the operation from where it left off.
Responses larger than one megabyte return a partial result set.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Implements the Dispose pattern for the AmazonSimpleDBClient
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonSimpleDBClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonSimpleDBClient with AWS Access Key ID, AWS Secret Key and an
AmazonSimpleDB Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonSimpleDB Configuration Object
Constructs an AmazonSimpleDBClient with AWS Access Key ID, AWS Secret Key and an
AmazonSimpleDB Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The AmazonSimpleDB Configuration Object
Initiates the asynchronous execution of the CreateDomain operation.
The CreateDomainRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCreateDomain.
Finishes the asynchronous execution of the CreateDomain operation.
The IAsyncResult returned by the call to BeginCreateDomain.
Returns a CreateDomainResponse from S3.
Create Domain
Create Domain request
Create Domain Response from the service
The CreateDomain operation creates a new domain. The domain name must be unique
among the domains associated with the Access Key ID provided in the request. The CreateDomain
operation may take 10 or more seconds to complete.
Convert CreateDomainRequest to name value pairs
Initiates the asynchronous execution of the ListDomains operation.
The ListDomainsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListDomains.
Finishes the asynchronous execution of the ListDomains operation.
The IAsyncResult returned by the call to BeginListDomains.
Returns a ListDomainsResponse from S3.
List Domains
List Domains request
List Domains Response from the service
The ListDomains operation lists all domains associated with the Access Key ID. It returns
domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more
than MaxNumberOfDomains domains. Calling ListDomains successive times with the
NextToken returns up to MaxNumberOfDomains more domain names each time.
Convert ListDomainsRequest to name value pairs
Initiates the asynchronous execution of the DomainMetadata operation.
The DomainMetadataRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDomainMetadata.
Finishes the asynchronous execution of the DomainMetadata operation.
The IAsyncResult returned by the call to BeginDomainMetadata.
Returns a DomainMetadataResponse from S3.
Domain Metadata
Domain Metadata request
Domain Metadata Response from the service
The DomainMetadata operation returns some domain metadata values, such as the
number of items, attribute names and attribute values along with their sizes.
Convert DomainMetadataRequest to name value pairs
Initiates the asynchronous execution of the DeleteDomain operation.
The DeleteDomainRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteDomain.
Finishes the asynchronous execution of the DeleteDomain operation.
The IAsyncResult returned by the call to BeginDeleteDomain.
Returns a DeleteDomainResponse from S3.
Delete Domain
Delete Domain request
Delete Domain Response from the service
The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain
are deleted as well. The DeleteDomain operation may take 10 or more seconds to complete.
Convert DeleteDomainRequest to name value pairs
Initiates the asynchronous execution of the PutAttributes operation.
The PutAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutAttributes.
Finishes the asynchronous execution of the PutAttributes operation.
The IAsyncResult returned by the call to BeginPutAttributes.
Returns a PutAttributesResponse from S3.
Put Attributes
Put Attributes request
Put Attributes Response from the service
The PutAttributes operation creates or replaces attributes within an item. You specify new attributes
using a combination of the Attribute.X.Name and Attribute.X.Value parameters. You specify
the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second
attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single
item can have the attributes { "first_name", "first_value" } and { "first_name",
second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and
Attribute.X.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual value. Setting this value
to true will cause the new attribute value to replace the existing attribute value(s). For example, if an
item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor does a
PutAttributes of { 'b', '4' } with the Replace parameter set to true, the final attributes of the
item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute
with the new value.
Convert PutAttributesRequest to name value pairs
Initiates the asynchronous execution of the BatchPutAttributes operation.
The BatchPutAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndBatchPutAttributes.
Finishes the asynchronous execution of the BatchPutAttributes operation.
The IAsyncResult returned by the call to BeginBatchPutAttributes.
Returns a BatchPutAttributesResponse from S3.
Batch Put Attributes
Batch Put Attributes request
Batch Put Attributes Response from the service
The BatchPutAttributes operation creates or replaces attributes within one or more items.
You specify the item name with the Item.X.ItemName parameter.
You specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters.
You specify the first attribute for the first item by the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value,
the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single
item can have the attributes { "first_name", "first_value" } and { "first_name",
second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and
Item.X.Attribute.Y.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual value. Setting this value
to true will cause the new attribute value to replace the existing attribute value(s). For example, if an
item 'I' has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor does a
BacthPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the
item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute
with the new value.
Convert BatchPutAttributesRequest to name value pairs
Initiates the asynchronous execution of the GetAttributes operation.
The GetAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetAttributes.
Finishes the asynchronous execution of the GetAttributes operation.
The IAsyncResult returned by the call to BeginGetAttributes.
Returns a GetAttributesResponse from S3.
Get Attributes
Get Attributes request
Get Attributes Response from the service
Returns all of the attributes associated with the item. Optionally, the attributes returned can be limited to
the specified AttributeName parameter.
If the item does not exist on the replica that was accessed for this operation, an empty attribute is
returned. The system does not return an error as it cannot guarantee the item does not exist on other
replicas.
Convert GetAttributesRequest to name value pairs
Initiates the asynchronous execution of the DeleteAttributes operation.
The DeleteAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteAttributes.
Finishes the asynchronous execution of the DeleteAttributes operation.
The IAsyncResult returned by the call to BeginDeleteAttributes.
Returns a DeleteAttributesResponse from S3.
Delete Attributes
Delete Attributes request
Delete Attributes Response from the service
Deletes one or more attributes associated with the item. If all attributes of an item are deleted, the item is
deleted.
Convert DeleteAttributesRequest to name value pairs
Initiates the asynchronous execution of the BatchDeleteAttributes operation.
The BatchDeleteAttributesRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndBatchDeleteAttributes.
Finishes the asynchronous execution of the BatchDeleteAttributes operation.
The IAsyncResult returned by the call to BeginBatchDeleteAttributes.
Returns a BatchDeleteAttributesResponse from S3.
Batch Delete Attributes
Batch Delete Attributes request
BatchDeleteAttributesResponse from the service
The BatchDeleteAttributes operation deletes attributes within one or more items.
An item name and a collection of is specified for each
item to have attributes deleted for. If no attributes are specified then the entire item will be deleted.
Initiates the asynchronous execution of the Select operation.
The SelectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSelect.
Finishes the asynchronous execution of the Select operation.
The IAsyncResult returned by the call to BeginSelect.
Returns a SelectResponse from S3.
Select
Select request
Select Response from the service
The Select operation returns a set of item names and associate attributes that match the
query expression. Select operations that run longer than 5 seconds will likely time-out
and return a time-out error response.
Convert SelectRequest to name value pairs
Configure HttpClient with set of defaults as well as configuration
from AmazonSimpleDBConfig instance
Look for additional error strings in the response and return formatted exception
Exponential sleep on failed request
Add authentication related and version parameters
Contains all the parameters
that can be set when making a this request with the
TransferUtility method.
Sets the Directory property for this request.
This is the location where files are uploaded from.
The value that Directory is set to
The request with the Directory set
Checks if Directory property is set.
true if Directory property is set.
Sets the KeyPrefix property for this request.
This value prefixed the generated object keys.
The value that KeyPrefix is set to
The request with the KeyPrefix set
Checks if KeyPrefix property is set.
true if KeyPrefix property is set.
Sets the search pattern used to determine which
files in the directory are uploaded
and returns this object instance,
enabling additional method calls to be chained together.
The SearchPattern is used for searching files in the directory.
The default is "*" which returns back all files.
The search pattern used to deterimine which
files in the directory are uploaded.
The default value is "*", specifying that all files
in the directory will be uploaded.
This object instance, enabling additional method calls to be chained together.
Checks if SearchPattern property is set.
true if SearchPattern property is set.
Sets the recursive options for the directory upload.
and returns this object instance,
enabling additional method calls to be chained together.
The recursive option for the directory upload.
Set by default to TopDirectoryOnly,
specifying that files will be uploaded from the root directory only.
This object instance, enabling additional method calls to be chained together.
Sets the name of the bucket
and returns this object instance,
enabling additional method calls to be chained together.
The name of the bucket.
This object instance, enabling additional method calls to be chained together.
Checks if BucketName property is set.
true if BucketName property is set.
Sets the canned access control list (ACL)
for the uploaded objects
and returns this object instance,
enabling additional method calls to be chained together.
Please refer to
for
information on Amazon S3 canned ACLs.
The canned access control list (ACL)
for the uploaded objects.
This object instance, enabling additional method calls to be chained together.
Checks if the CannedACL property is set.
true if there is the CannedACL property is set.
Removes the cannned access control list (ACL)
for the uploaded object.
Adds a set of key-value pairs to the request
and returns this object instance,
enabling additional method calls to be chained together.
The key to associate with the Amazon S3 object.
The value for the key.
This object instance, enabling additional method calls to be chained together.
Adds a set of key-value pairs to the request
and returns this object instance,
enabling additional method calls to be chained together.
The set of key-value pairs
associated with the Amazon S3 object.
This object instance, enabling additional method calls to be chained together.
Checks if Metadata property is set.
true if Metadata property is set.
Removes a key from the metadata list if it was
added previously.
The key to remove.
Sets the storage class for the uploaded Amazon S3 object.
and returns this object instance,
enabling additional method calls to be chained together.
Please refer to
for
information on S3 Storage Classes.
The storage class for the uploaded Amazon S3 object.
This object instance, enabling additional method calls to be chained together.
Sets the sets the timeout property in milliseconds
and returns this object instance,
enabling additional method calls to be chained together.
Set the timeout only if certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
The timeout in milliseconds.
A value less than or equal to 0 will be silently ignored.
This object instance, enabling additional method calls to be chained together.
The handler will be attached to the UploadDirectoryProgressEvent which is fired as data
is uploaded to S3. The handler will be passed information detailing how much data
has been uploaded as well as how much will be uploaded.
A method that is called when UploadDirectoryProgressEvent is fired.
this instance of the TransferUtilityUploadDirectoryRequest
Causes the UploadDirectoryProgressEvent event to be fired.
The number of files uploaded.
The total number of files.
The current file.
The transferred bytes for current file.
The total number of bytes for current file.
Gets or sets the directory where files are uploaded from.
The directory where files are uploaded from.
Gets or sets the KeyPrefix property. As object keys are generated for the
files being uploaded this value will prefix the key. This is useful when a directory
needs to be uploaded into sub directory in the S3 Bucket.
The directory where files are uploaded from.
Gets and sets the search pattern used to determine which
files in the directory are uploaded.
The search pattern used to deterimine which
files in the directory are uploaded.
The default value is "*", specifying that all files
in the directory will be uploaded.
Gets or sets the recursive options for the directory upload.
The recursive options for the directory upload.
Set by default to TopDirectoryOnly,
specifying that files will be uploaded from the root directory only.
Gets or sets the name of the bucket.
The name of the bucket.
Gets or sets the canned access control list (ACL)
for the uploaded objects.
Please refer to
for
information on Amazon S3 canned ACLs.
The canned access control list (ACL)
for the uploaded objects.
This is exposed so we can copy the collection to the PUT object request
created from this.
Gets or sets the storage class for the uploaded Amazon S3 objects.
Please refer to
for
information on S3 Storage Classes.
The storage class for the uploaded Amazon S3 objects.
Gets or sets the timeout property in milliseconds.
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for Amazon S3 GET Object requests.
A value less than or equal to 0 will be silently ignored.
The event for UploadDirectoryProgressEvent notifications. All
subscribers will be notified when a new progress
event is raised.
The UploadDirectoryProgressEvent is fired as data
is uploaded to S3. The delegates attached to the event
will be passed information detailing how much data
has been uploaded as well as how much will be uploaded.
Subscribe to this event if you want to receive
UploadDirectoryProgressEvent notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, UploadDirectoryProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the UploadDirectoryProgressEvent delegate's invocation list
TransferUtilityUploadDirectoryRequest request = new TransferUtilityUploadDirectoryRequest();
request.UploadDirectoryProgressEvent += displayProgress;
Encapsulates the information needed to provide
transfer progress to subscribers of the UploadDirectory
event.
Constructs a new instance of UploadDirectoryProgressArgs.
The number of files uploaded.
The total number of files to upload.
The current file
The number of transferred bytes for current file.
The size of the current file in bytes.
Gets or sets the total number of files.
The total number of files.
Gets or sets the number of files uploaded.
The number of files uploaded.
Gets or sets the current file.
The current file.
Gets or sets the transferred bytes for current file.
The transferred bytes for current file.
Gets or sets the total number of bytes for current file.
The total number of bytes for current file.
An Enumeration of all possible CannedACLs that can be used
for S3 Buckets or S3 Objects. For more information about CannedACLs, refer:
No Canned ACL is used.
Owner gets FULL_CONTROL.
No one else has access rights (default).
Owner gets FULL_CONTROL and the anonymous principal is granted READ access.
If this policy is used on an object, it can be read from a browser with no authentication.
Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access.
This can be a useful policy to apply to a bucket, but is generally not recommended.
Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon
S3 user is granted READ access.
Object Owner gets FULL_CONTROL, Bucket Owner gets READ
This ACL applies only to objects and is equivalent to private when used with PUT Bucket.
You use this ACL to let someone other than the bucket owner write content (get full control)
in the bucket but still grant the bucket owner read access to the objects.
Object Owner gets FULL_CONTROL, Bucket Owner gets FULL_CONTROL.
This ACL applies only to objects and is equivalent to private when used with PUT Bucket.
You use this ACL to let someone other than the bucket owner write content (get full control)
in the bucket but still grant the bucket owner full rights over the objects.
An enumeration of all possible S3 Bucket region possibilities. For
more information, refer:
Specifies that the S3 Bucket should use US locality.
This is the default value.
Specifies that the S3 Bucket should use EU locality.
Specifies that the S3 Bucket should use US-WEST-1 locality.
Specifies that the S3 Bucket should use the AP-SOUTHEAST-1 locality.
Specifies that the S3 Bucket should use the AP-NORTHEAST-1 locality.
An enumeration of all ACL permissions. For more information, refer:
An invalid permission that will not make the request invalid.
When applied to a bucket, grants permission to list the bucket.
When applied to an object, this grants permission to read the
object data and/or metadata.
When applied to a bucket, grants permission to create, overwrite,
and delete any object in the bucket. This permission is not
supported for objects.
Grants permission to read the ACL for the applicable bucket or object.
The owner of a bucket or object always has this permission implicitly.
Gives permission to overwrite the ACP for the applicable bucket or object.
The owner of a bucket or object always has this permission implicitly.
Granting this permission is equivalent to granting FULL_CONTROL because
the grant recipient can make any changes to the ACP.
Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions.
It does not convey additional rights and is provided only for convenience.
An enumeration of all Metadata directives that
can be used for the CopyObject operation.
Specifies that the metadata is copied from the source object.
Specifies that the metadata is replaced with metadata provided in the request.
All original metadata is replaced by the metadata you specify.
An enumeration of all protocols that the pre-signed
URL can be created against.
https protocol will be used in the pre-signed URL.
http protocol will be used in the pre-signed URL.
An enumeration of supported HTTP verbs
The GET HTTP verb.
The HEAD HTTP verb.
The PUT HTTP verb.
The DELETE HTTP verb.
Specifies the Storage Class of of an S3 object. Possible values
are:
- ReducedRedundancy: provides a 99.9% durability guarantee
- Standard: provides a 999999999% durability guarantee
The STANDARD storage class, which is the default
storage class for S3 objects. Provides a 999999999%
durability guarantee.
The REDUCED_REDUNDANCY storage class for S3 objects. This
provides a reduced (99.9%) durability guarantee at a lower
cost as compared to the STANDARD storage class. Use this
storage class for non-mission critical data or for data
that doesn’t require the higher level of durability that S3
provides with the STANDARD storage class.
The constants for the known event names used by S3 notification. S3 might add new
events before the SDK is updated. In which case the names listed in the S3 documentation
will work as well as these constants.
An event that says an object has been lost in the reduced redundancy storage.
The ListVersionsRequest contains the parameters used for the ListVersions operation.
Required Parameters: BucketName
Optional Parameters: Prefix, KeyMarker, VersionIdMarker, MaxKeys, Delimiter
Sets the BucketName property for this request.
This is the name of the S3 Bucket to list keys from.
The value that BucketName is set to
this instance
Checks if BucketName property is set
true if BucketName property is set
Sets the Prefix property for this request.
All keys matched will have this prefix.
The value that Prefix is set to
this instance
Checks if Prefix property is set
true if Prefix property is set
Sets the KeyMarker property for this request.
Specifies the key in the bucket you want to start
listing from.
the value that KeyMarker is set to
this instance
Checks if KeyMarker property is set
true if KeyMarker property is set
Sets the VersionIdMarker property for this request.
Specifies the objert-version in the bucket you want to start
listing from.
the value that VersionIdMarker is set to
this instance
Checks if VersionIdMarker property is set
true if VersionIdMarker property is set
Sets the MaxKeys property for this request.
Limits the result set of keys to MaxKeys.
the value that MaxKeys is set to
this instance
Checks if MaxKeys property is set
true if MaxKeys property is set
Sets the Delimiter property for this request.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
the value that Delimiter is set to.
this instance
Checks if Delimiter property is set
true if Delimiter property is set
Gets and sets the BucketName property.
This is the name of the S3 Bucket to list keys from.
Gets and sets the Prefix property.
All keys matched will have this prefix.
Gets and sets the KeyMarker property.
Specifies the key in the bucket you want to start
listing from.
Gets and sets the VersionIdMarker property.
Specifies the object-version in the bucket you want to start
listing from.
Gets and sets the MaxKeys property.
Limits the result set of keys to MaxKeys.
Gets and sets the Delimiter property.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
The DeleteBucketPolicyRequest contains the parameters used for the DeleteBucketPolicy operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket where the policy will be deleted from.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
This is a dynamic wrapper around log4net so we can avoid log4net being required
to be distributed with the SDK.
This should be a one time call to use reflection to find all the types and methods
needed for the logging API.
Simple wrapper around the log4net Error method.
Simple wrapper around the log4net Debug method.
Simple wrapper around the log4net DebugFormat method.
Simple wrapper around the log4net InfoFormat method.
Response Unmarshaller for ResetDBParameterGroup operation
Result Unmarshaller for PurchaseReservedDBInstancesOffering operation
Event Unmarshaller
DescribeReservedDBInstancesResult Unmarshaller
Describe D B Snapshots Request Marshaller
DescribeDBInstancesResult Unmarshaller
Delete D B Snapshot Request Marshaller
Create D B Security Group Request Marshaller
Container for the parameters to the RebootDBInstance operation.
Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with
ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS
instance during which the RDS instance status is set to rebooting. A DBInstance event is created when the reboot is completed.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
The DB Instance identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 alphanumeric
characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The results from the PurchaseReservedDBInstancesOffering action.
Gets and sets the PurchaseReservedDBInstancesOfferingResult property.
Contains the result of a successful invocation of the PurchaseReservedDBInstancesOffering
action.
Returns information about the DescribeReservedDBInstancesResult response and response metadata.
Gets and sets the DescribeReservedDBInstancesResult property.
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
Container for the parameters to the DescribeDBSecurityGroups operation.
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of
the specified DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The name of the DB Security Group to return details for.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
Returns information about the DescribeDBParametersResult response and response metadata.
Gets and sets the DescribeDBParametersResult property.
Contains the result of a successful invocation of the DescribeDBParameters action.
Contains the result of a successful invocation of the following actions:
- CreateDBInstance
- DeleteDBInstance
- ModifyDBInstance
This data type is used as a response element in the DescribeDBInstances action.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Engine property
The value to set for the Engine property
this instance
Sets the DBInstanceStatus property
The value to set for the DBInstanceStatus property
this instance
Sets the MasterUsername property
The value to set for the MasterUsername property
this instance
Sets the DBName property
The value to set for the DBName property
this instance
Sets the Endpoint property
The value to set for the Endpoint property
this instance
Sets the AllocatedStorage property
The value to set for the AllocatedStorage property
this instance
Sets the InstanceCreateTime property
The value to set for the InstanceCreateTime property
this instance
Sets the PreferredBackupWindow property
The value to set for the PreferredBackupWindow property
this instance
Sets the BackupRetentionPeriod property
The value to set for the BackupRetentionPeriod property
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Adds elements to the DBParameterGroups collection
The values to add to the DBParameterGroups collection
this instance
Adds elements to the DBParameterGroups collection
The values to add to the DBParameterGroups collection
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the PreferredMaintenanceWindow property
The value to set for the PreferredMaintenanceWindow property
this instance
Sets the PendingModifiedValues property
The value to set for the PendingModifiedValues property
this instance
Sets the LatestRestorableTime property
The value to set for the LatestRestorableTime property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
Sets the ReadReplicaSourceDBInstanceIdentifier property
The value to set for the ReadReplicaSourceDBInstanceIdentifier property
this instance
Adds elements to the ReadReplicaDBInstanceIdentifiers collection
The values to add to the ReadReplicaDBInstanceIdentifiers collection
this instance
Adds elements to the ReadReplicaDBInstanceIdentifiers collection
The values to add to the ReadReplicaDBInstanceIdentifiers collection
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.
Contains the name of the compute and memory capacity class of the DB Instance.
Provides the name of the database engine to be used for this DB Instance.
Specifies the current state of this database.
Contains the master username for the DB Instance.
The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of
this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the
life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance.
Specifies the connection endpoint.
Specifies the allocated storage size specified in gigabytes.
Provides the date and time the DB Instance was created.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod.
Specifies the number of days for which automatic DB Snapshots are retained.
Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Provides the list of DB Parameter Groups applied to this DB Instance.
Specifies the name of the Availability Zone the DB Instance is located in.
Specifies the weekly time range (in UTC) during which system maintenance can occur.
Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are
identified by subelements.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies if the DB Instance is a Multi-AZ deployment.
Indicates the database engine version.
Indicates that minor version patches are applied automatically.
Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
Contains one or more identifiers of the Read Replicas associated with this DB Instance.
License model information for this DB Instance.
The results from the CreateDBParameterGroup action.
Gets and sets the CreateDBParameterGroupResult property.
Contains the result of a successful invocation of the CreateDBParameterGroup
action.
Container for the parameters to the UpdateJob operation.
You use this operation to change the parameters specified in
the original manifest file by supplying a new manifest file. The
manifest file attached to this request replaces the original manifest
file. You can only use the operation after a CreateJob request but
before the data transfer starts and you can only use it on jobs you
own.
Sets the JobId property
The value to set for the JobId property
this instance
Sets the Manifest property
The value to set for the Manifest property
this instance
Sets the JobType property
The value to set for the JobType property
this instance
Sets the ValidateOnly property
The value to set for the ValidateOnly property
this instance
A unique identifier which refers to a particular job.
The UTF-8 encoded text of the manifest file.
Specifies whether the job to initiate is an import or export job.
Constraints:
-
Allowed Values
Import, Export
Validate the manifest and parameter values in the request but do not
actually create a job.
Response Unmarshaller for ListJobs operation
AmazonImportExport exception
Constructs a new MissingParameterException with the specified error
message.
Describes the error encountered.
Output structure for the ListJobs operation.
Adds elements to the Jobs collection
The values to add to the Jobs collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
A list container for Jobs returned by the ListJobs operation.
Indicates whether the list of jobs was truncated. If true, then call
ListJobs again using the last JobId element as the marker.
UploadServerCertificateResult Unmarshaller
Update Signing Certificate Request Marshaller
ServerCertificate Unmarshaller
List User Policies Request Marshaller
Get Group Policy Request Marshaller
Delete Server Certificate Request Marshaller
Response Unmarshaller for DeleteGroup operation
Add User To Group Request Marshaller
Container for the parameters to the ResyncMFADevice operation.
Synchronizes the specified MFA device with AWS servers.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the SerialNumber property
The value to set for the SerialNumber property
this instance
Sets the AuthenticationCode1 property
The value to set for the AuthenticationCode1 property
this instance
Sets the AuthenticationCode2 property
The value to set for the AuthenticationCode2 property
this instance
Name of the User whose MFA device you want to resynchronize.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Serial number that uniquely identifies the MFA device.
Constraints:
-
Length
9 - 48
-
Pattern
[\w]*
An authentication code emitted by the device.
Constraints:
-
Length
6 - 6
-
Pattern
[\d]*
A subsequent authentication code emitted by the device.
Constraints:
-
Length
6 - 6
-
Pattern
[\d]*
Container for the parameters to the ListAccessKeys operation.
Returns information about the Access Key IDs associated with the
specified User. If there are none, the action returns an empty
list. Although each User is limited to a small number of
keys, you can still paginate the results using the MaxItems and
Marker parameters. If the UserName field is
not specified, the UserName is determined implicitly based on the AWS
Access Key ID used to sign the request. Because this action works for
access keys under the AWS Account, this API can be used to manage root
credentials even if the AWS Account has no associated Users.
NOTE:To ensure the security of your AWS Account, the
secret access key is accessible only during key and User
creation.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
Name of the User.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are
truncated. Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this parameter only when paginating results to indicate the maximum number of keys you want in the response. If there are additional
keys beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Contains the result of a successful invocation of the
GetLoginProfile action.
Sets the LoginProfile property
The value to set for the LoginProfile property
this instance
Login profile for the User name.
Container for the parameters to the DeleteServerCertificate operation.
Deletes the specified server certificate.
IMPORTANT:If your Elastic Load Balancing instances are
using a server certificate, deleting the certificate could have
implications for your application. If your Elastic Load Balancing
instances do not detect the deletion of bound certificates, they may
continue to use the certificates. This could cause them to stop
accepting traffic. We recommend that you remove the reference to the
certificate from your Elastic Load Balancing instances before using
this command to delete the certificate.
Sets the ServerCertificateName property
The value to set for the ServerCertificateName property
this instance
The name of the server certificate you want to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the DeleteGroup operation.
Deletes the specified group. The group must not contain any
Users or have any attached policies.
Sets the GroupName property
The value to set for the GroupName property
this instance
Name of the group to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The AccessKey data type contains information about an AWS access
key, without its secret key. This data type is used as a
response element in the action ListAccessKeys.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the AccessKeyId property
The value to set for the AccessKeyId property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the CreateDate property
The value to set for the CreateDate property
this instance
Name of the User the key is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The ID for this access key.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
Constraints:
-
Allowed Values
Active, Inactive
The date when the access key was created.
Container for the parameters to the RunJobFlow operation.
RunJobFlow creates and starts running a new job flow. The job
flow will run the steps specified. Once the job flow completes, the
cluster is stopped and the HDFS partition is lost. To prevent loss of
data, configure the last step of the job flow to store results in
Amazon S3. If the JobFlowInstancesDetail : KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE , the job flow will transition to the
WAITING state rather than shutting down once the steps have completed.
A maximum of 256 steps are allowed in each job
flow. For long running job flows, we recommended that you
periodically store your results.
Sets the Name property
The value to set for the Name property
this instance
Sets the LogUri property
The value to set for the LogUri property
this instance
Sets the AdditionalInfo property
The value to set for the AdditionalInfo property
this instance
Sets the Instances property
The value to set for the Instances property
this instance
Adds elements to the Steps collection
The values to add to the Steps collection
this instance
Adds elements to the BootstrapActions collection
The values to add to the BootstrapActions collection
this instance
The name of the job flow.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the location in Amazon S3 to write the log files of the job
flow. If a value is not provided, logs are not created.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A JSON string for selecting additional features.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A specification of the number and type of Amazon EC2 instances on
which to run the job flow.
A list of steps to be executed by the job flow.
A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.
Returns information about the ModifyInstanceGroups response metadata.
The ModifyInstanceGroups operation has a void result type.
Set Load Balancer Policies Of Listener Request Marshaller
Enable Availability Zones For Load Balancer Request Marshaller
Response Unmarshaller for DisableAvailabilityZonesForLoadBalancer operation
Delete Load Balancer Request Marshaller
This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing
security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide .
Sets the OwnerAlias property
The value to set for the OwnerAlias property
this instance
Sets the GroupName property
The value to set for the GroupName property
this instance
Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the
Amazon EC2 command line tool.
Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon
EC2 command line tool.
AmazonElasticLoadBalancing exception
Constructs a new InvalidConfigurationRequestException with the specified error
message.
Describes the error encountered.
Returns information about the DescribeInstanceHealthResult response and response metadata.
Gets and sets the DescribeInstanceHealthResult property.
The output for the DescribeInstanceHealth action.
Container for the parameters to the DescribeInstanceHealth operation.
Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the
instances for the LoadBalancer is returned. NOTE: The client must have created the specified input LoadBalancer in
order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.
Default constructor for a new DescribeInstanceHealthRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DescribeInstanceHealthRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of instance IDs whose states are being queried.
The output for the CreateLBCookieStickinessPolicy action.
An error or warning for a desired configuration option value.
Sets the Message property
The value to set for the Message property
this instance
Sets the Severity property
The value to set for the Severity property
this instance
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the OptionName property
The value to set for the OptionName property
this instance
A message describing the error or warning.
An indication of the severity of this message: error: This message indicates that this is not a valid
setting for an option. warning: This message is providing information you should take into account.
- error: This message indicates that this is not a valid setting for an option.
- warning: This message is
providing information you should take into account.
Constraints:
-
Allowed Values
error, warning
Constraints:
-
Length
1 - 255
Constraints:
-
Length
1 - 100
Container for the parameters to the UpdateConfigurationTemplate operation.
Updates the specified configuration template to have the specified properties or configuration option values.
NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties,
specify an empty string. Related Topics
- DescribeConfigurationOptions
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
The name of the application associated with the configuration template to update. If no application is found with this name,
UpdateConfigurationTemplate returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate
returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
A new description for the configuration.
Constraints:
-
Length
0 - 200
A list of configuration option settings to update with the new specified option value.
A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration
options.
Describes a trigger.
Sets the Name property
The value to set for the Name property
this instance
The name of the trigger.
TerminateEnvironmentResult Unmarshaller
Swap Environment C N A M Es Request Marshaller
Describe Environment Resources Request Marshaller
Response Unmarshaller for DescribeConfigurationOptions operation
Response Unmarshaller for DescribeApplicationVersions operation
ConfigurationOptionSetting Unmarshaller
AutoScalingGroup Unmarshaller
Describes an event.
Sets the EventDate property
The value to set for the EventDate property
this instance
Sets the Message property
The value to set for the Message property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the RequestId property
The value to set for the RequestId property
this instance
Sets the Severity property
The value to set for the Severity property
this instance
The date when the event occurred.
The event message.
The application associated with the event.
Constraints:
-
Length
1 - 100
The release label for the application version associated with this event.
Constraints:
-
Length
1 - 100
The name of the configuration associated with this event.
Constraints:
-
Length
1 - 100
The name of the environment associated with this event.
Constraints:
-
Length
4 - 23
The web service request ID for the activity of this event.
The severity level of this event.
Constraints:
-
Allowed Values
TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Result message containing a list of environment descriptions.
Adds elements to the Environments collection
The values to add to the Environments collection
this instance
Adds elements to the Environments collection
The values to add to the Environments collection
this instance
Returns an EnvironmentDescription list.
Returns information about the DescribeConfigurationOptionsResult response and response metadata.
Gets and sets the DescribeConfigurationOptionsResult property.
Describes the settings for a specified configuration set.
Returns information about the DescribeApplicationsResult response and response metadata.
Gets and sets the DescribeApplicationsResult property.
Result message containing a list of application descriptions.
Container for the parameters to the DeleteConfigurationTemplate operation.
Deletes the specified configuration template. NOTE:When you launch an environment using a configuration template,
the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running
environment.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
The name of the application to delete the configuration template from.
Constraints:
-
Length
1 - 100
The name of the configuration template to delete.
Constraints:
-
Length
1 - 100
Describes the settings for a configuration set.
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the DeploymentStatus property
The value to set for the DeploymentStatus property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
The name of the solution stack this configuration set uses.
Constraints:
-
Length
0 - 100
The name of the application associated with this configuration set.
Constraints:
-
Length
1 - 100
If not null, the name of the configuration template for this configuration set.
Constraints:
-
Length
1 - 100
Describes this configuration set.
Constraints:
-
Length
0 - 200
If not null, the name of the environment for this configuration set.
Constraints:
-
Length
4 - 23
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this
configuration set: null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the
process of deploying. deployed: This is the configuration that is currently deployed to the
associated running environment. failed: This is a draft configuration, that failed to successfully
deploy. - null: This configuration is not associated with a running environment.
-
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
- deployed: This is the configuration that is currently deployed to the associated running environment.
- failed:
This is a draft configuration that failed to successfully deploy.
Constraints:
-
Allowed Values
deployed, pending, failed
The date (in UTC time) when this configuration set was created.
The date (in UTC time) when this configuration set was last modified.
A list of the configuration options and their values in this configuration set.
Describes the properties of an application.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Adds elements to the Versions collection
The values to add to the Versions collection
this instance
Adds elements to the Versions collection
The values to add to the Versions collection
this instance
Adds elements to the ConfigurationTemplates collection
The values to add to the ConfigurationTemplates collection
this instance
Adds elements to the ConfigurationTemplates collection
The values to add to the ConfigurationTemplates collection
this instance
The name of the application.
Constraints:
-
Length
1 - 100
User-defined description of the application.
Constraints:
-
Length
0 - 200
The date when the application was created.
The date when the application was last modified.
The names of the versions for this application.
The names of the configuration templates associated with this application.
Result of a StartInstances request.
Checks if StartingInstances property is set
true if StartingInstances property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the StartingInstances property.
The Response for the
ReplaceNetworkAclAssociation operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ReplaceNetworkAclAssociationResult property is set
true if ReplaceNetworkAclAssociationResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ReplaceNetworkAclAssociationResult property.
ReplaceNetworkAclAssociation Result
Sets the From property
The first port in the range. A value of -1 indicates all ports.
this instance
Checks if From property is set
true if From property is set
Sets the To property
The last port in the range. A value of -1 indicates all ports
this instance
Checks if To property is set
true if To property is set
Gets and sets the From property.
The first port in the range. A value of -1 indicates all ports.
Gets and sets the To property.
The last port in the range. A value of -1 indicates all ports
Sets the RuleNumber property
Specific rule number for the entry. ACL entries are processed in
ascending order by rule number.
this instance
Checks if RuleNumber property is set
true if RuleNumber property is set
Sets the Protocol property
IP protocol. For a list of protocol numbers and names, go to Protocol
Numbers.
Valid Values: tcp | udp | icmp or an IP protocol number.
this instance
Checks if Protocol property is set
true if Protocol property is set
Sets the RuleAction property
Whether to allow or deny the traffic that matches the rule.
Valid Values: allow | deny
this instance
Checks if RuleAction property is set
true if RuleAction property is set
Sets the Egress property
Boolean flag to indicate an egress rule (rule is applied to traffic leaving
the subnet). Value of true indicates egress.
this instance
Checks if Egress property is set
true if Egress property is set
Sets the CidrBlock property
The network range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the Icmp property
For the ICMP protocol, this is the ICMP type and code.
this instance
Checks if Icmp property is set
true if Icmp property is set
Sets the PortRange property
For the TCP or UDP protocols, the range of ports the rule applies to.
this instance
Checks if PortRange property is set
true if PortRange property is set
Gets and sets the RuleNumber property.
Specific rule number for the entry. ACL entries are processed in
ascending order by rule number.
Gets and sets the Protocol property.
IP protocol. For a list of protocol numbers and names, go to Protocol
Numbers.
Valid Values: tcp | udp | icmp or an IP protocol number.
Gets and sets the RuleAction property.
Whether to allow or deny the traffic that matches the rule.
Valid Values: allow | deny
Gets and sets the Egress property.
Boolean flag to indicate an egress rule (rule is applied to traffic leaving
the subnet). Value of true indicates egress.
Gets and sets the CidrBlock property.
The network range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).
Gets and sets the Icmp property.
For the ICMP protocol, this is the ICMP type and code.
Gets and sets the PortRange property.
For the TCP or UDP protocols, the range of ports the rule applies to.
Modifies an attribute of an instance.
Sets the InstanceId property
The instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Attribute property
Name of the attribute to modify. Values are
"instanceType", "kernel", "ramdisk",
"userData", "disableApiTermination",
"instanceInitiatedShutdownBehavior",
"sourceDestCheck",
"rootDeviceName", and "blockDeviceMapping"
this instance
Checks if Attribute property is set
true if Attribute property is set
Sets the Value property
New value of the attribute.
this instance
Checks if Value property is set
true if Value property is set
Sets the BlockDeviceMapping property
Modifies the mapping that defines native device names
to use when exposing virtual devices.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Sets the GroupId property
This is applicable only to instances running in a VPC. Use
this parameter when you want to change the security
groups an instance is in. The new set of groups you specify
replaces the current set. You must specify at least one
group, even if it's just the default security group in the VPC.
this instance
Checks if GroupId property is set
true if GroupId property is set
Gets and sets the InstanceId property.
The instance ID.
Gets and sets the Attribute property.
Name of the attribute to modify. Values are
"instanceType", "kernel", "ramdisk",
"userData", "disableApiTermination",
"instanceInitiatedShutdownBehavior",
"sourceDestCheck",
"rootDeviceName", and "blockDeviceMapping"
Gets and sets the Value property.
New value of the attribute.
Gets and sets the BlockDeviceMapping property.
Modifies the mapping that defines native device names
to use when exposing virtual devices.
Gets and sets the GroupId property.
This is applicable only to instances running in a VPC. Use
this parameter when you want to change the security
groups an instance is in. The new set of groups you specify
replaces the current set. You must specify at least one
group, even if it's just the default security group in the VPC.
IP Permission
Sets the IpProtocol property
IP protocol.Valid Values: tcp | udp | icmp
this instance
Checks if IpProtocol property is set
true if IpProtocol property is set
Sets the FromPort property
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e., any ICMP type
number).
this instance
Checks if FromPort property is set
true if FromPort property is set
Sets the ToPort property
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
this instance
Checks if ToPort property is set
true if ToPort property is set
Sets the Groups property
List of security group and user ID pairs.
this instance
Checks if Groups property is set
true if Groups property is set
Sets the IpRanges property
IP ranges.
this instance
Checks if IpRanges property is set
true if IpRanges property is set
Gets and sets the IpProtocol property.
IP protocol.Valid Values: tcp | udp | icmp
Gets and sets the FromPort property.
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e., any ICMP type
number).
Gets and sets the ToPort property.
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
Gets and sets the Groups property.
List of security group and user ID pairs.
Gets and sets the IpRanges property.
IP ranges.
Sets the BytesConverted property
Number of bytes converted so far.
this instance
Checks if BytesConverted property is set
true if BytesConverted property is set
Sets the AvailabilityZone property
The Availability Zone where the resulting volume will reside.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Description property
Description you provided when starting the import volume task.
this instance
Checks if Description property is set
true if Description property is set
Sets the Image property
Information about the image.
this instance
Checks if Image property is set
true if Image property is set
Sets the Volume property
Information about the volume.
this instance
Checks if Volume property is set
true if Volume property is set
Gets and sets the BytesConverted property.
Number of bytes converted so far.
Gets and sets the AvailabilityZone property.
The Availability Zone where the resulting volume will reside.
Gets and sets the Description property.
Description you provided when starting the import volume task.
Gets and sets the Image property.
Information about the image.
Gets and sets the Volume property.
Information about the volume.
The Response for the
ImportInstance operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ImportInstanceResult property is set
true if ImportInstanceResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ImportInstanceResult property.
Import Instance Result
Creates a new import instance task using metadata from the specified disk image.
Sets the Description property
Description of the instance being imported
this instance
Checks if Description property is set
true if Description property is set
Sets the LaunchSpecification property
Specifies additional launch instance information.
this instance
Checks if LaunchSpecification property is set
true if LaunchSpecification property is set
Sets the DiskImage property
Details about the image.
this instance
Checks if DiskImage property is set
true if DiskImage property is set
Sets the Platform property
The EC2 instance operating system.
Valid Value: Windows
this instance
Checks if Platform property is set
true if Platform property is set
Gets and sets the Description property.
Description of the instance being imported
Gets and sets the LaunchSpecification property.
Specifies additional launch instance information.
Gets and sets the DiskImage property.
Details about the image.
Gets and sets the Platform property.
The EC2 instance operating system.
Valid Value: Windows
A filter used to limit results when describing tags.
Multiple values can be specified per filter.
A tag must match at least one of the specified values for it to be
returned from an operation.
Wildcards can be included in filter values;
* specifies that zero or more characters
must match, and ? specifies that exactly one
character must match.Use a backslash to escape special characters.
For example, a filter value of \*amazon\?\\
specifies the literal string *amazon?\.
Sets the Name property
Specifies the name of the filter.
this instance
Checks if Name property is set
true if Name property is set
Sets the Value property
Contains one or more values for the filter.
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the Name property.
Specifies the name of the filter.
Gets and sets the Value property.
Contains one or more values for the filter.
Detach Volume Result
Checks if Attachment property is set
true if Attachment property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Attachment property.
Volume attachment
Returns information about Amazon EBS snapshots
available to the user.
Information returned includes volume ID,
status, start time, progress, owner ID,
volume size, and
description. Snapshots available to the user include public
snapshots available for any
user to launch, private snapshots owned
by the user making the
request, and private
snapshots owned by other
users for which the user granted explicit create
volume permissions.
The create volume permissions fall into 3 categories:
public
The owner of the snapshot granted create volume permissions
for the snapshot to the all
group. All users have create volume
permissions for these snapshots.
explicit
The owner of the snapshot
granted create volume permissions to a
specific user.
implicit
A user has implicit create volume permissions for all snapshots he
or she owns.
The list of snapshots returned can be modified by specifying
snapshot IDs, snapshot owners, or users with create volume permissions.
If no options are specified, Amazon EC2 returns all
snapshots for which the user has
create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have
the specified IDs are returned. If you specify an invalid snapshot ID,
a fault is returned. If you specify a
snapshot ID for which you do not have access, it will not be included in
the returned results.
If you specify one or more snapshot owners, only snapshots from the
specified owners and for which you have access are returned. The
results can include the AWS Account
IDs of the specified owners,
amazon for snapshots owned by Amazon or
self for snapshots that you own.
If you specify a list of restorable users, only users that
have create snapshot permissions
for the snapshots are returned. You
can specify AWS Account IDs (if
you own the snapshot(s)), self for
snapshots for which you own or have explicit
permissions, or all for public snapshots.
Sets the SnapshotId property
The ID of the Amazon EBS snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the Owner property
Returns snapshots owned by the specified
owner. Valid Values: self |
amazon | AWS
Account ID
this instance
Checks if Owner property is set
true if Owner property is set
Sets the RestorableBy property
Account ID of a user that can create volumes
from the snapshot.
this instance
Checks if RestorableBy property is set
true if RestorableBy property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified Snapshots.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the SnapshotId property.
The ID of the Amazon EBS snapshot.
Gets and sets the Owner property.
Returns snapshots owned by the specified
owner. Valid Values: self |
amazon | AWS
Account ID
Gets and sets the RestorableBy property.
Account ID of a user that can create volumes
from the snapshot.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified Snapshots.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
DescribeRouteTables Result
Checks if RouteTables property is set
true if RouteTables property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the RouteTables property.
A list of route tables.
Information returned by the DescribePlacementGroup request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribePlacementGroupsResult property is set
true if DescribePlacementGroupsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribePlacementGroupsResult property.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeLicensesResult property is set
true if DescribeLicensesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeLicensesResult property.
Describe Customer Gateways Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeCustomerGatewaysResult property is set
true if DescribeCustomerGatewaysResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeCustomerGatewaysResult property.
Describe Customer Gateways Result
Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Sets the ConversionTaskId property
A list of conversion tasks.
this instance
Checks if ConversionTaskId property is set
true if ConversionTaskId property is set
Gets and sets the ConversionTaskId property.
A list of conversion tasks.
Describe Bundle Tasks Result
Checks if BundleTask property is set
true if BundleTask property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the BundleTask property.
Bundle Task
Displays Availability Zones that are currently
available to the account and their states.
Availability Zones are
not the same across accounts. The Availability Zone
us-east-1a for account A is not necessarily the
same as us-east-1a for account B.
Zone assignments are mapped independently for each account.
Sets the ZoneName property
Availability Zone name.
this instance
Checks if ZoneName property is set
true if ZoneName property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with the specified
AvailabilityZones.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the ZoneName property.
Availability Zone name.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with the specified
AvailabilityZones.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Deregister Image Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
The response includes information that you need
to configure your customer gateway, in XML format.
Sets the Type property
The type of VPN connection
this instance
Checks if Type property is set
true if Type property is set
Sets the CustomerGatewayId property
The ID of the customer gateway.
this instance
Checks if CustomerGatewayId property is set
true if CustomerGatewayId property is set
Sets the VpnGatewayId property
The ID of the VPN gateway.
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Gets and sets the Type property.
The type of VPN connection
Gets and sets the CustomerGatewayId property.
The ID of the customer gateway.
Gets and sets the VpnGatewayId property.
The ID of the VPN gateway.
Verifies whether a Amazon DevPay product code is associated with an
instance. This can only be executed by the owner of the AMI and is
useful when an AMI owner wants to verify whether a user's instance is
eligible for support.
Sets the ProductCode property
The product code to confirm.
this instance
Checks if ProductCode property is set
true if ProductCode property is set
Sets the InstanceId property
The instance to confirm.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the ProductCode property.
The product code to confirm.
Gets and sets the InstanceId property.
The instance to confirm.
Cancels an Amazon EC2 bundling operation.
Sets the BundleId property
The ID of the bundle task to cancel.
this instance
Checks if BundleId property is set
true if BundleId property is set
Gets and sets the BundleId property.
The ID of the bundle task to cancel.
Authorize Security GroupIngress Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
AmazonEC2Client is an implementation of AmazonEC2;
the client allows you to manage your AmazonEC2 resources.
If you want to use the AmazonEC2Client from a Medium Trust
hosting environment, please create the client with an
AmazonEC2Config object whose UseSecureStringForAwsSecretKey
property is false.
The Amazon Elastic Compute Cloud (Amazon EC2) web
service provides you with
the ability to execute your applications in
Amazon's computing environment.
To use Amazon EC2 you simply:
1. Create an Amazon Machine Image (AMI) containing all your software,
including your operating system and associated configuration settings,
applications, libraries, etc. Think of this as zipping up the contents
of your hard drive. We provide all the necessary tools to create and
package your AMI.
2. Upload this AMI to the Amazon S3 (Amazon Simple
Storage Service) service. This gives us reliable,
secure access to your AMI.
3. Register your AMI with Amazon EC2. This allows us to verify
that your AMI has been uploaded correctly and to allocate a unique
identifier for it.
4. Use this AMI ID and the Amazon EC2 web service
APIs to run, monitor, and
terminate as many instances of this AMI as
required.
You can also skip the first three steps and choose to launch
an AMI that is provided by Amazon or shared by another user.
While instances are running, you are billed for the computing
and network resources that they consume.
You can also skip the first three steps
and choose to launch an AMI that is
provided by Amazon or shared by
another user.
While instances are running, you are billed for the
computing and network
resources that they consume.
The Amazon Elastic Compute Cloud (Amazon EC2) web
service provides you with
the ability to execute your applications in
Amazon's computing environment.
To use Amazon EC2 you simply:
1. Create an Amazon Machine Image (AMI) containing all your software,
including your operating system and associated configuration settings,
applications, libraries, etc. Think of this as zipping up the contents
of your hard drive. We provide all the necessary tools to create and
package your AMI.
2. Upload this AMI to the Amazon S3 (Amazon Simple
Storage Service) service. This gives us reliable,
secure access to your AMI.
3. Register your AMI with Amazon EC2. This allows us to verify
that your AMI has been uploaded correctly and to allocate a unique
identifier for it.
4. Use this AMI ID and the Amazon EC2 web service
APIs to run, monitor, and
terminate as many instances of this AMI as
required.
You can also skip the first three steps and choose to launch
an AMI that is provided by Amazon or shared by another user.
While instances are running, you are billed for the computing
and network resources that they consume.
You can also skip the first three steps
and choose to launch an AMI that is
provided by Amazon or shared by
another user.
While instances are running, you are billed for the
computing and network
resources that they consume.
Activate License
Activate License request
Activate License Response from the service
Activates a specific number of licenses for a 90-day period.
Activations can be done against a specific license ID.
Allocate Address
Allocate Address request
Allocate Address Response from the service
The AllocateAddress operation acquires an elastic
IP address for use with your account.
Associate Address
Associate Address request
Associate Address Response from the service
The AssociateAddress operation associates an
elastic IP address with an instance.
If the IP address is currently
assigned to another instance, the IP
address is assigned to the new
instance. This is an idempotent operation. If you enter
it more than once, Amazon EC2 does not return an error.
Attach Volume
Attach Volume request
Attach Volume Response from the service
Attach a previously created volume to a running
instance.
Authorize Security Group Ingress
Authorize Security Group Ingress request
Authorize Security Group Ingress Response from the service
The AuthorizeSecurityGroupIngress operation adds
permissions to a security group.
Permissions are specified by the IP
protocol (TCP, UDP or ICMP), the source of
the request (by IP range
or an Amazon EC2 user-group pair), the
source and destination port ranges (for TCP and UDP),
and the ICMP codes and types (for ICMP).
When authorizing ICMP, -1 can be used as a wildcard in the
type and code fields.
Permission changes are propagated to instances within the
security group as quickly as possible. However, depending on the
number of instances, a small
delay might occur.
When authorizing a user/group pair permission, GroupName,
SourceSecurityGroupName and
SourceSecurityGroupOwnerId must be
specified. When authorizing a CIDR
IP permission, GroupName, IpProtocol, FromPort, ToPort and
CidrIp must be specified. Mixing these two types of parameters is
not allowed.
Bundle Instance
Bundle Instance request
Bundle Instance Response from the service
The BundleInstance operation request that an
instance is bundled the next time it boots.
The bundling process creates a new image from a running instance and
stores the AMI data in S3. Once bundled, the image must be registered in the
normal way using the RegisterImage API.
Cancel Bundle Task
Cancel Bundle Task request
Cancel Bundle Task Response from the service
CancelBundleTask operation cancels a pending or
in-progress bundling task. This is an asynchronous
call and it make
take a while for the task to be cancelled.
If a task is cancelled
while it is storing items,
there may be parts of the incomplete AMI
stored in S3.
It is up to the caller to clean up these parts from S3.
Confirm Product Instance
Confirm Product Instance request
Confirm Product Instance Response from the service
The ConfirmProductInstance operation returns true
if the specified product code
is attached to the specified instance.
The operation returns false if the
product code is not attached to the
instance.
The ConfirmProductInstance operation can only be executed
by the owner of the
AMI. This feature is useful when an AMI owner is
providing support and wants to
verify whether a user's instance is eligible.
Create Image
Create Image request
Create Image Response from the service
Creates an AMI that uses an Amazon EBS root
device from a "running" or "stopped" instance.
AMIs that use an Amazon EBS root device boot
faster than AMIs that use instance stores. They
can be up to 1 TiB in size, use storage that
persists on instance failure, and can be stopped and started.
Create Key Pair
Create Key Pair request
Create Key Pair Response from the service
The CreateKeyPair operation creates a new 2048
bit RSA key pair and returns a
unique ID that can be used to reference
this key pair when launching new
instances. For more information, see
RunInstances.
Create Placement Group
Create Placement Group request
Create Placement Group Response from the service
The CreateKeyPair operation creates a new 2048
bit RSA key pair and returns a
unique ID that can be used to reference
this key pair when launching new
instances. For more information, see
RunInstances.
Create Security Group
Create Security Group request
Create Security Group Response from the service
The CreateSecurityGroup operation creates a new
security group.
Every instance is launched in a security group. If no security group is
specified during launch, the instances are launched in the default
security group. Instances within the same security
group have unrestricted network access to each other. Instances will
reject network access attempts from other instances in a different
security group. As the owner of instances you can grant or revoke
specific permissions using the AuthorizeSecurityGroupIngress
and RevokeSecurityGroupIngress operations.
Create Snapshot
Create Snapshot request
Create Snapshot Response from the service
Create a snapshot of the volume identified by
volume ID. A volume does not have to be detached
at the time the snapshot is taken.
Important Note:
Snapshot creation requires that the
system is in a consistent state.
For instance, this means that if
taking a snapshot of a database, the
tables must be read-only locked
to ensure that the snapshot will not contain a
corrupted version of the database. Therefore,
be careful when using this API to ensure that
the system remains in the consistent state until the create
snapshot status has returned.
Create Tags
Create Tags request
Create Tags Response from the service
Adds or overwrites one or more tags for the specified 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.
Create Volume
Create Volume request
Create Volume Response from the service
Initializes an empty volume of a given size
Deactivate License
Deactivate License request
Deactivate License Response from the service
Deactivates a specific number of licenses.
Deactivations can be done against a specific license ID
after they have persisted for at least a 90-day period.
Delete Key Pair
Delete Key Pair request
Delete Key Pair Response from the service
The DeleteKeyPair operation deletes a key pair.
Delete Placement Group
Delete Placement Group request
Delete Placement Group Response from the service
The DeletePlacementGroup operation deletes a placement group.
Delete Security Group
Delete Security Group request
Delete Security Group Response from the service
The DeleteSecurityGroup operation deletes a
security group.
Note:
If you attempt to delete a security group that
contains instances, a fault is returned.
If you attempt to delete a
security group that is referenced by
another security group, a fault
is returned. For example, if security group B has a
rule that allows access from security group A, security group A
cannot be deleted until the allow rule is removed.
Delete Snapshot
Delete Snapshot request
Delete Snapshot Response from the service
Deletes the snapshot identitied by snapshotId.
Delete Tags
Delete Tags request
Delete Tags Response from the service
Deletes the snapshot identitied by snapshotId.
Delete Volume
Delete Volume request
Delete Volume Response from the service
Deletes a previously created volume. Once
successfully deleted, a new
volume can be created with the same name.
Deregister Image
Deregister Image request
Deregister Image Response from the service
The DeregisterImage operation deregisters an AMI.
Once deregistered, instances
of the AMI can no longer be launched.
Describe Addresses
Describe Addresses request
Describe Addresses Response from the service
The DescribeAddresses operation lists elastic IP
addresses assigned to your account.
Describe Availability Zones
Describe Availability Zones request
Describe Availability Zones Response from the service
The DescribeAvailabilityZones operation describes
availability zones that are
currently available to the account and
their states.
Availability zones are not the same across accounts.
The availability zone
us-east-1a for account A is not necessarily the
same as us-east-1a for account
B. Zone assignments are mapped
independently for each account.
Describe Bundle Tasks
Describe Bundle Tasks request
Describe Bundle Tasks Response from the service
The DescribeBundleTasks operation describes in-progress
and recent bundle tasks. Complete and failed tasks are
removed from the list a short time after completion.
If no bundle ids are given, all bundle tasks are returned.
Describe Licenses
Describe Licenses request
Describe Licenses Response from the service
Provides details of a user's registered licenses. Zero or more IDs
may be specified on the call. When one or more license IDs are
specified, only data for the specified IDs are returned.
Describe Placement Groups
Describe Placement Groups request
Describe Placement Groups Response from the service
Returns information about one or more PlacementGroup instances in a
user's account.
Describe Snapshot Attribute
Describe Snapshot Attribute request
Describe Snapshot Attribute Response from the service
Returns information about an attribute of a snapshot.
Only one attribute can be specified per call.
Describe Image Attribute
Describe Image Attribute request
Describe Image Attribute Response from the service
The DescribeImageAttribute operation returns
information about an attribute of
an AMI. Only one attribute can be
specified per call.
Describe Images
Describe Images request
Describe Images Response from the service
The DescribeImages operation returns information
about AMIs, AKIs, and ARIs
available to the user. Information returned
includes image type, product codes,
architecture, and kernel and RAM
disk IDs. Images available to the user include
public images
available for any user to launch, private images owned
by the user making the request, and private images
owned by other users for which the
user has explicit launch permissions.
Launch permissions fall into three categories:
Public:
The owner of the AMI granted launch permissions for the AMI to the all
group. All users have launch permissions for these AMIs.
Explicit:
The owner of the AMI granted launch permissions to a specific user.
Implicit:
A user has implicit launch permissions for all AMIs he or she owns.
The list of AMIs returned can be modified by specifying AMI IDs, AMI
owners, or users with launch permissions. If no options are specified,
Amazon EC2 returns all AMIs for which the user has launch permissions.
If you specify one or more AMI IDs, only AMIs that have the specified
IDs are returned. If you specify an invalid AMI ID, a fault is returned.
If you specify an AMI ID for which you do not have access, it will not
be included in the returned results.
If you specify one or more AMI
owners, only AMIs from the specified
owners and for which you have
access are returned. The results can include the
account IDs of the specified owners, amazon for
AMIs owned by Amazon or self for AMIs that you own.
If you specify a list of executable users, only users
that have launch
permissions for the AMIs are returned. You can
specify account IDs
(if you own
the AMI(s)), self for AMIs for which
you own or have explicit
permissions, or
all for public AMIs.
Note:
Deregistered images are included in the returned results for an
unspecified
interval after deregistration.
Describe Instances
Describe Instances request
Describe Instances Response from the service
The DescribeInstances operation returns
information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns
information for those instances. If you do not specify
instance IDs, Amazon EC2 returns information for
all relevant instances. If you specify an invalid
instance ID, a fault is returned. If you specify an instance
that you do not own, it will
not be included in the returned results.
Recently terminated instances might appear in the
returned results. This interval is usually less than one hour.
Describe Regions
Describe Regions request
Describe Regions Response from the service
The DescribeRegions operation describes regions
zones that are
currently available to the account.
Describe Reserved Instances
Describe Reserved Instances request
Describe Reserved Instances Response from the service
The DescribeReservedInstances operation describes
Reserved Instances
that were purchased for use with your account.
Describe Reserved Instances Offerings
Describe Reserved Instances Offerings request
Describe Reserved Instances Offerings Response from the service
The DescribeReservedInstancesOfferings operation
describes Reserved
Instance offerings that are available for
purchase. With Amazon EC2
Reserved Instances, you purchase the right
to launch Amazon EC2 instances
for a period of time (without getting
insufficient capacity errors) and
pay a lower usage rate for the
actual time used.
Describe Key Pairs
Describe Key Pairs request
Describe Key Pairs Response from the service
The DescribeKeyPairs operation returns information about key pairs
available to you. If you specify key pairs, information about
those key pairs is returned. Otherwise,
information for all registered key pairs is returned.
Describe Security Groups
Describe Security Groups request
Describe Security Groups Response from the service
The DescribeSecurityGroups operation returns
information about security groups
that you own.
If you specify security group names, information about those security
group is returned. Otherwise, information for all security group is
returned. If you specify a group that does not exist, a fault is returned.
Describe Snapshots
Describe Snapshots request
Describe Snapshots Response from the service
Describes the indicated snapshots, or in lieu of
that, all snapshots owned by the caller.
Describe Tags
Describe Tags request
Describe Tags Response from the service
Describes the indicated snapshots, or in lieu of
that, all snapshots owned by the caller.
Describe Volumes
Describe Volumes request
Describe Volumes Response from the service
Describes the status of the indicated or, in lieu
of any specified, all
volumes belonging to the caller.
Volumes that
have been deleted are not described.
Detach Volume
Detach Volume request
Detach Volume Response from the service
Detach a previously attached volume from a
running instance.
Disassociate Address
Disassociate Address request
Disassociate Address Response from the service
The DisassociateAddress operation disassociates
the specified elastic IP
address from the instance to which it is
assigned. This is an idempotent
operation. If you enter it more than
once, Amazon EC2 does not
return an error.
Get Password Data
Get Password Data request
Get Password Data Response from the service
Retrieves the encrypted administrator password
for the instances running
Windows.
Get Console Output
Get Console Output request
Get Console Output Response from the service
The GetConsoleOutput operation retrieves console
output for the specified instance.
Instance console output is buffered
and posted shortly after instance boot,
reboot, and termination. Amazon EC2 preserves the
most recent 64 KB output which will be
available for at least one hour after the most recent post.
Import Key Pair
Import Key Pair request
Import Key Pair Response from the service
The GetConsoleOutput operation retrieves console
output for the specified instance.
Instance console output is buffered
and posted shortly after instance boot,
reboot, and termination. Amazon EC2 preserves the
most recent 64 KB output which will be
available for at least one hour after the most recent post.
Modify Snapshot Attribute
Modify Snapshot Attribute request
Modify Snapshot Attribute Response from the service
Adds or remove permission settings for the
specified snapshot.
Modify Image Attribute
Modify Image Attribute request
Modify Image Attribute Response from the service
The ModifyImageAttribute operation modifies an
attribute of an AMI.
Purchase Reserved Instances Offering
Purchase Reserved Instances Offering request
Purchase Reserved Instances Offering Response from the service
The PurchaseReservedInstancesOffering operation
purchases a Reserved Instance for use with your account.
With Amazon EC2 Reserved Instances, you purchase the
right to launch Amazon EC2 instances for a period of time
(without getting insufficient capacity errors) and pay a
lower usage rate for the actual time used.
Reboot Instances
Reboot Instances request
Reboot Instances Response from the service
The RebootInstances operation requests a reboot
of one or more instances. This
operation is asynchronous; it only
queues a request to reboot the specified
instance(s). The operation
will succeed if the instances are valid
and belong to the user.
Requests to reboot terminated instances are ignored.
Register Image
Register Image request
Register Image Response from the service
The RegisterImage operation registers an AMI with
Amazon EC2. Images must be
registered before they can be launched. For
more information, see RunInstances.
Each AMI is associated with an
unique ID which is provided by the Amazon EC2
service through the RegisterImage operation.
During registration, Amazon EC2
retrieves the specified image manifest from
Amazon S3 and verifies that the image
is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2.
Any modifications to an image in Amazon S3 invalidates this
registration. If you make changes to an image, deregister the
previous image and register the new
image. For more information, see DeregisterImage.
Release Address
Release Address request
Release Address Response from the service
The ReleaseAddress operation releases an elastic
IP address associated with your account.
Note:
Releasing an IP address
automatically disassociates it from any instance with
which it is associated. For more information, see
DisassociateAddress.
Important:
After releasing an elastic IP address, it is released to the IP
address pool and might no longer be available to your account. Make
sure to update your DNS records and any servers or devices that
communicate with the address.
If you run this operation on an elastic
IP address that is already released,
the address might be assigned to
another account which will cause
Amazon EC2 to return an error.
Reset Snapshot Attribute
Reset Snapshot Attribute request
Reset Snapshot Attribute Response from the service
Resets permission settings for the specified
snapshot.
Reset Image Attribute
Reset Image Attribute request
Reset Image Attribute Response from the service
The ResetImageAttribute operation resets an
attribute of an AMI to its default value.
Note:
The productCodes
attribute cannot be reset.
Revoke Security Group Ingress
Revoke Security Group Ingress request
Revoke Security Group Ingress Response from the service
The RevokeSecurityGroupIngress operation revokes
permissions from a security
group. The permissions used to revoke must
be specified using the same values
used to grant the permissions.
Permissions are specified by IP protocol (TCP, UDP, or ICMP), the
source of the request (by IP range or an Amazon EC2 user-group pair),
the source and destination port ranges (for TCP and UDP), and the ICMP
codes and types (for ICMP).
Permission changes are quickly propagated
to instances within the security
group. However, depending on the
number of instances in the group, a
small delay is might occur, .
When revoking a user/group pair permission, GroupName,
SourceSecurityGroupName
and SourceSecurityGroupOwnerId must be
specified. When authorizing a
CIDR IP permission, GroupName,
IpProtocol, FromPort, ToPort and CidrIp must be
specified. Mixing these two types of parameters is not allowed.
Run Instances
Run Instances request
Run Instances Response from the service
The RunInstances operation launches a specified
number of instances.
If Amazon EC2 cannot launch the minimum number
AMIs you request, no instances
launch. If there is insufficient
capacity to launch the maximum number of AMIs
you request, Amazon EC2
launches as many as possible to satisfy the
requested maximum values.
Every instance is launched in a security group. If you do not
specify a security group at launch, the instances start in your
default security group. For more information on creating security
groups, see CreateSecurityGroup.
An optional instance type can be
specified. For information about
instance types, see Instance Types.
You can provide an optional key pair ID for each image in the launch
request (for more information, see CreateKeyPair). All instances that
are created from images that use this key pair will have access to the
associated public key at boot. You can use this key to provide secure
access to an instance of an image on a per-instance basis. Amazon EC2
public images use this feature to provide secure access without passwords.
Important:
Launching public images without a key pair ID will leave them inaccessible.
The public key material is made available to the instance at boot
time by placing it in the openssh_id.pub file on a logical device that is exposed
to the instance as /dev/sda2 (the ephemeral store). The format of this
file is suitable for use as an entry within ~/.ssh/authorized_keys (the
OpenSSH format). This can be done at boot (e.g., as part of rc.local)
allowing for secure access without passwords.
Optional user data can be provided in the launch request. All instances that
collectively comprise the launch request have access to this data
For more information, see Instance Metadata.
Note:
If any of the AMIs have a product code attached for which the user has
not subscribed, the RunInstances call will fail.
Important:
We strongly recommend using
the 2.6.18 Xen stock kernel with the
c1.medium and c1.xlarge
instances. Although the default Amazon EC2 kernels will work, the
new kernels provide greater stability and performance for these
instance types. For more information about kernels, see Kernels, RAM
Disks, and Block Device Mappings.
Stop Instances
Stop Instances request
Stop Instances Response from the service
Stops an instance that uses an Amazon EBS volume
as its root device. 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.
Start Instances
Start Instances request
Start Instances Response from the service
Starts an instance that uses an Amazon EBS volume as its root device.
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.
Modify Instance Attribute
Modify Instance Attribute request
Modify Instance Attribute Response from the service
Modifies an attribute of an instance.
Reset Instance Attribute
Reset Instance Attribute request
Reset Instance Attribute Response from the service
Resets an attribute of an instance to its default
value.
Describe Instance Attribute
Describe Instance Attribute request
Describe Instance Attribute Response from the service
Returns information about an attribute of an
instance. Only one attribute
can be specified per call.
Terminate Instances
Terminate Instances request
Terminate Instances Response from the service
The TerminateInstances operation shuts down one
or more instances. This
operation is idempotent; if you terminate an
instance more than
once, each call
will succeed.
Terminated instances
will remain visible after termination (approximately one hour).
Monitor Instances
Monitor Instances request
Monitor Instances Response from the service
Enables monitoring for a running instance.
Unmonitor Instances
Unmonitor Instances request
Unmonitor Instances Response from the service
Disables monitoring for a running instance.
Describe Vpn Connections
Describe Vpn Connections request
Describe Vpn Connections Response from the service
Gives you information about your VPN connections.
Important -
We strongly recommend you use HTTPS when calling this operation because the
response contains sensitive cryptographic information for configuring your customer gateway.
You can filter the results to return information only about VPN connections
that match criteria you specify. For example, you could ask to get information
about a particular VPN connection (or all) only if the VPN's state is pending
or available. You can specify multiple filters (e.g., the VPN connection is
associated with a particular VPN gateway, and the gateway's state is
pending or available). The result includes information for a particular
VPN connection only if the VPN connection matches all your filters.
If there's no match, no special message is returned; the response is
simply empty.
Describe Subnets
Describe Subnets request
Describe Subnets Response from the service
Gives you information about your subnets. You can filter the results to
return information only about subnets that match criteria you specify.
For example, you could ask to get information about a particular subnet
(or all) only if the subnet's state is available. You can specify multiple
filters (e.g., the subnet is in a particular VPC, and the subnet's state is
available). The result includes information for a particular subnet only
if the subnet matches all your filters. If there's no match, no special
message is returned; the response is simply empty. The following table
shows the available filters.
Detach Vpn Gateway
Detach Vpn Gateway request
Detach Vpn Gateway Response from the service
Detaches a VPN 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 VPN gateway
has been completely detached from a VPC by describing the VPN gateway
(any attachments to the VPN gateway are also described).
You must wait for the attachment's state to switch to detached before you can
delete the VPC or attach a different VPC to the VPN gateway.
Describe Vpcs
Describe Vpcs request
Describe Vpcs Response from the service
Gives you information about your VPCs. You can filter the results to return
information only about VPCs that match criteria you specify. For example,
you could ask to get information about a particular VPC or VPCs (or all your VPCs)
only if the VPC's state is available. You can specify multiple filters (e.g.,
the VPC uses one of several sets of DHCP options, and the VPC's state is available).
The result includes information for a particular VPC only if the VPC
matches all your filters. If there's no match, no special message is
returned; the response is simply empty.
Delete Customer Gateway
Delete Customer Gateway request
Delete Customer Gateway Response from the service
Deletes a customer gateway. You must delete the VPN connection before
deleting the customer gateway.
AWS might delete any customer gateway if you leave it inactive for an extended
period of time (inactive means that there's no VPN connection in use with the
customer gateway).
Attach Vpn Gateway
Attach Vpn Gateway request
Attach Vpn Gateway Response from the service
Attaches a VPN gateway to a VPC. This is the last step required to get your
VPC fully connected to your data center before launching instances in it.
For more information, go to Process for Using Amazon VPC in the Amazon Virtual
Private Cloud Developer Guide.
Delete Dhcp Options
Delete Dhcp Options request
Delete Dhcp Options Response from the service
Deletes a set of DHCP options that you specify. Amazon VPC returns an error if the
set of options you specify is currently associated with a VPC. You can disassociate
the set of options by associating either a new set of options or the default options with the VPC.
Delete Subnet
Delete Subnet request
Delete Subnet Response from the service
Deletes a subnet from a VPC. You must terminate all running instances in the
subnet before deleting it, otherwise Amazon VPC returns an error.
AWS might delete any subnet if you leave it inactive for an extended period
of time (inactive means that there are no running Amazon EC2 instances in the subnet).
Create Vpc
Create Vpc request
Create Vpc Response from the service
Creates a VPC with the CIDR block you specify. The smallest VPC you can create
uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask
(16,384 IP addresses). To help you decide how big to make your VPC, go
to the topic about creating VPCs in the Amazon Virtual Private Cloud
Developer Guide.
By default, each instance you launch in the VPC has the default DHCP options
(the standard EC2 host name, no domain name, no DNS server, no NTP server, and
no NetBIOS server or node type).
AWS might delete any VPC that you create with this operation if you leave it inactive
for an extended period of time (inactive means that there are no running Amazon EC2
instances in the VPC).
Create Customer Gateway
Create Customer Gateway request
Create Customer Gateway Response from the service
Provides information to AWS about your customer gateway device.
The customer gateway is the appliance at your end of the VPN connection
(compared to the VPN gateway, which is the device at the AWS side of the VPN
connection). AWS might delete any customer gateway that you create with this
operation if you leave it inactive for an extended period of time (inactive means
that there's no VPN connection in use with the customer gateway).
You must provide the Internet-routable IP address of the customer gateway's external
interface. The IP address must be static and can't be behind a device performing
network address translation (NAT).
You must also provide the device's Border Gateway Protocol (BGP) Autonomous
System Number (ASN). You can use an existing ASN assigned to your network.
If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
For more information about ASNs, go to the Wikipedia article -
http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29.
Create Vpn Gateway
Create Vpn Gateway request
Create Vpn Gateway Response from the service
Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint for
your VPN connection. You can create a VPN gateway before creating the VPC
itself. AWS might delete any VPN gateway that you create with this operation
if you leave it inactive for an extended period of time (inactive means
that there's no VPN connection in use with the VPN gateway).
Delete Vpc
Delete Vpc request
Delete Vpc Response from the service
Deletes a VPC. You must terminate all running instances and delete all
subnets before deleting the VPC, otherwise Amazon VPC returns an error.
AWS might delete any VPC if you leave it inactive for an extended period of time
(inactive means that there are no running Amazon EC2 instances in the VPC).
Associate Dhcp Options
Associate Dhcp Options request
Associate Dhcp Options Response from the service
Associates a set of DHCP options (that you've previously created) with the specified VPC.
Or, associates the default DHCP options with the VPC. The default set consists of the standard
EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type.
After you associate the options with the VPC, any existing instances and all new instances
that you launch in that VPC use the options. For more information about the supported DHCP
options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual
Private Cloud Developer Guide.
Describe Vpn Gateways
Describe Vpn Gateways request
Describe Vpn Gateways Response from the service
Gives you information about your VPN gateways. You can filter the results to return
information only about VPN gateways that match criteria you specify. For example,
you could ask to get information about a particular VPN gateway (or all) only if the
gateway's state is pending or available. You can specify multiple filters (e.g., the
VPN gateway is in a particular Availability Zone and the gateway's state is pending or
available). The result includes information for a particular VPN gateway only if the
gateway matches all your filters. If there's no match, no special message is returned;
the response is simply empty.
Create Subnet
Create Subnet request
Create Subnet Response from the service
Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC.
If you add more than one subnet to a VPC, they're set up in a star topology with
a logical router in the middle. If you feel you need more than 20 subnets, you can
request more by going to http://aws.amazon.com/contact-us/vpc-request/.
When you create each subnet, you provide the VPC ID and the CIDR block you
want for the subnet. Once you create a subnet, you can't change its CIDR block.
The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you
want only a single subnet in the VPC), or a subset of the VPC's CIDR block.
If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap.
The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses),
and the largest uses a /18 netmask (16,384 IP addresses).
Important -
AWS reserves both the first four and the last IP address in each subnet's CIDR block.
They're not available for use.
AWS might delete any subnet you create with this operation if you leave it inactive
for an extended period of time (inactive means that there are no running Amazon EC2
instances in the subnet).
Delete Vpn Connection
Delete Vpn Connection request
Delete Vpn Connection Response from the service
Deletes a VPN connection. Use this if you want to delete a VPC and
all its associated components. Another reason to use this operation
is if you believe the tunnel credentials for your VPN connection have
been compromised. In that situation, you can delete the VPN connection
and create a new one that has new keys, without needing to delete the
VPC or VPN gateway. If you create a new VPN connection, you must
reconfigure the customer gateway using the new configuration
information returned with the new VPN connection ID.
If you're deleting the VPC and all its associated parts, we recommend you
detach the VPN gateway from the VPC and delete the VPC before deleting
the VPN connection.
Delete Vpn Gateway
Delete Vpn Gateway request
Delete Vpn Gateway Response from the service
Deletes a VPN gateway. Use this when you want to delete a VPC and all
its associated components because you no longer need them. We recommend
that before you delete a VPN gateway, you detach it from the VPC and
delete the VPN connection. Note that you don't need to delete the VPN
gateway if you just want to delete and re-create the VPN connection
between your VPC and data center.
AWS might delete any VPN gateway if you leave it inactive for an extended period of time
(inactive means that there's no VPN connection in use with the VPN gateway).
Describe Customer Gateways
Describe Customer Gateways request
Describe Customer Gateways Response from the service
Gives you information about your customer gateways. You can filter the results to return
information only about customer gateways that match criteria you specify. For example,
you could ask to get information about a particular customer gateway (or all) only if
the gateway's state is pending or available. You can specify multiple filters (e.g.,
the customer gateway has a particular IP address for the Internet-routable external
interface, and the gateway's state is pending or available). The result includes
information for a particular customer gateway only if the gateway matches all your
filters. If there's no match, no special message is returned; the response is simply empty.
Create Vpn Connection
Create Vpn Connection request
Create Vpn Connection Response from the service
Creates a new VPN connection between an existing VPN gateway and customer
gateway. The only supported connection type is ipsec.1.
The response includes information that you need to configure your customer gateway,
in XML format. We recommend you use the command line version of this operation
(ec2-create-vpn-connection), which lets you get the configuration information
formatted in a friendlier way. For information about the command, go to
ec2-create-vpn-connection in the Amazon Virtual Private Cloud Command Line Reference.
Important -
We strongly recommend you use HTTPS when calling this operation because
the response contains sensitive cryptographic information for configuring
your customer gateway.
If you decide to shut down your VPN connection for any reason and then create a new
one, you must re-configure your customer gateway with the new information
returned from this call.
Describe Dhcp Options
Describe Dhcp Options request
Describe Dhcp Options Response from the service
Gives you information about one or more sets of DHCP options. You can specify
one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options).
The returned information consists of:
- The DHCP options set ID
- The options
Create Dhcp Options
Create Dhcp Options request
Create Dhcp Options Response from the service
Creates a set of DHCP options that you can then associate with one or more VPCs,
causing all existing and new instances that you launch in those VPCs to use the
set of DHCP options. The following table lists the individual DHCP options you can
specify. For more information about the options, go to RFC 2132 - http://www.ietf.org/rfc/rfc2132.txt
Request Spot Instances
Request Spot Instances request
Request Spot Instances Response from the service
Creates a Spot Instance request. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Describe Spot Instance Requests
Describe Spot Instance Requests request
Describe Spot Instance Requests Response from the service
Describes Spot Instance requests. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Cancel Spot Instance Requests
Cancel Spot Instance Requests request
Cancel Spot Instance Requests Response from the service
Cancels Spot Instance requests. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Describe Spot Price History
Describe Spot Price History request
Describe Spot Price History Response from the service
Describes historical pricing for Spot Instances. Spot Instances are instances that automatically launch
when your request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Create Spot Datafeed Subscription
Create Spot Datafeed Subscription request
Create Spot Datafeed Subscription Response from the service
Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can
create one data feed per account.
Describe Spot Datafeed Subscription
Describe Spot Datafeed Subscription request
Describe Spot Datafeed Subscription Response from the service
Describes the data feed for Spot Instances.
Delete Spot Datafeed Subscription
Delete Spot Datafeed Subscription request
Delete Spot Datafeed Subscription Response from the service
Deletes the data feed for Spot Instances.
Cancel Conversion Task
Cancel Conversion Task request
Cancel Conversion Task Response from the service
Cancels an active conversion task. The task can be the import of an instance or volume. The command removes all artifacts of
the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
Describe Conversion Tasks
Describe Conversion Tasks request
Describe Conversion Tasks Response from the service
Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Import Instance
Import Instance request
Import Instance Response from the service
Creates a new import instance task using metadata from the specified disk image. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Import Volume
Import Volume request
Import Volume Response from the service
Creates a new import volume task using metadata from the specified disk image. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Authorize Security Group Egress
Authorize Security Group Egress request
Authorize Security Group Egress Response from the service
This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action adds one or more egress rules to a VPC security group. Specifically, this permits instances
in a security group to send traffic to either one or more destination CIDR IP address ranges, or to one or
more destination security groups in the same VPC.
Each rule consists of the protocol (e.g., TCP), plus either a CIDR range, or a source group. For the TCP
and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you
must also specify the ICMP type and code.You can use -1 as a wildcard for the ICMP type or code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Adding hundreds of rules to a security group might cause problems when you access the instance.
We recommend you condense your rules as much as possible.
Revoke Security Group Egress
Revoke Security Group Egress request
Revoke Security Group Egress Response from the service
This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action removes one or more egress rules from a VPC security group. The values that you specify in
the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be
revoked.
Each rule consists of the protocol, and the CIDR range or destination security group. For the TCP and
UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you
must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Create Internet Gateway
Create Internet Gateway request
Create Internet Gateway Response from the service
Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you then attach
it to a VPC using AttachInternetGateway. For more information about your VPC and Internet gateway,
go to Amazon Virtual Private Cloud User Guide.
Describe Internet Gateways
Describe Internet Gateways request
Describe Internet Gateways Response from the service
Gives you information about your Internet gateways.You can filter the results to return information only
about Internet gateways that match criteria you specify. For example, you could get information only
about gateways with particular tags. The Internet gateway must match at least one of the specified values
for it to be included in the results.
You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged
with a particular value). The result includes information for a particular Internet gateway only if the gateway
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Internet Gateway
Delete Internet Gateway request
Delete Internet Gateway Response from the service
Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For
more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
Attach Internet Gateway
Attach Internet Gateway request
Attach Internet Gateway Response from the service
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For
more information about your VPC and Internet gateway, go to the Amazon Virtual Private Cloud User
Guide.
Detach Internet Gateway
Detach Internet Gateway request
Detach Internet Gateway Response from the service
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. For more information about your
VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
For more information about Amazon Virtual Private Cloud and Internet gateways, go to the Amazon Virtual
Private Cloud User Guide.
Create Route Table
Create Route Table request
Create Route Table Response from the service
Creates a new route table within a VPC. After you create a new route table, you can add routes and
associate the table with a subnet. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Describe Route Tables
Describe Route Tables request
Describe Route Tables Response from the service
Gives you information about your route tables.You can filter the results to return information only about
tables that match criteria you specify. For example, you could get information only about a table associated
with a particular subnet.You can specify multiple values for the filter. The table must match at least one
of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular
subnet). The result includes information for a particular table only if it matches all your filters. If there's
no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Route Table
Delete Route Table request
Delete Route Table Response from the service
Deletes a route table from a VPC. The route table must not be associated with a subnet.You can't delete
the main route table. For more information about route tables, go to Route Tables in the Amazon Virtual
Private Cloud User Guide.
Associate Route Table
Associate Route Table request
Associate Route Table Response from the service
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 if you want to disassociate the route table
from the subnet later. A route table can be associated with multiple subnets.
For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User
Guide.
Replace Route Table Association
Replace Route Table Association request
Replace Route Table Association Response from the service
Changes the route table associated with a given subnet in a VPC. After you execute this action, the subnet
uses the routes in the new route table it's associated with. For more information about route tables, go
to Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use this 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 that you want to be the new main route table.
Disassociate Route Table
Disassociate Route Table request
Disassociate Route Table Response from the service
Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead it uses the
routes in the VPC's main route table. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Create Route
Create Route request
Create Route Response from the service
Creates a new route in a route table within a VPC. The route's target can be either a gateway attached
to the VPC or a NAT instance in the VPC.
When determining how to route traffic, we use the route with the most specific match. For example, let's
say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific,
so we use that route to determine where to target the traffic.
For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User
Guide.
Replace Route
Replace Route request
Replace Route Response from the service
Replaces an existing route within a route table in a VPC. For more information about route tables, go to
Route Tables in the Amazon Virtual Private Cloud User Guide.
Delete Route
Delete Route request
Delete Route Response from the service
Deletes a route from a route table in a VPC. For more information about route tables, go to Route Tables
in the Amazon Virtual Private Cloud User Guide.
Create Network Acl
Create Network Acl request
Create Network Acl Response from the service
Creates a new network ACL in a VPC. Network ACLs provide an optional layer of security (on top of
security groups) for the instances in your VPC. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Describe Network Acls
Describe Network Acls request
Describe Network Acls Response from the service
Gives you information about the network ACLs in your VPC.You can filter the results to return information
only about ACLs that match criteria you specify. For example, you could get information only the ACL
associated with a particular subnet. The ACL must match at least one of the specified values for it to be
included in the results.
You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress
entry that denies traffic to a particular port). The result includes information for a particular ACL only if it
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Network Acl
Delete Network Acl request
Delete Network Acl Response from the service
Deletes a network ACL from a VPC. The ACL must not have any subnets associated with it.You can't
delete the default network ACL. For more information about network ACLs, go to Network ACLs in the
Amazon Virtual Private Cloud User Guide.
Replace Network Acl Association
Replace Network Acl Association request
Replace Network Acl Association Response from the service
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, go to
Network ACLs in the Amazon Virtual Private Cloud User Guide.
Create Network Acl Entry
Create Network Acl Entry request
Create Network Acl Entry Response from the service
Creates an entry (i.e., rule) in a network ACL with a rule number you specify. Each network ACL has a
set of numbered ingress rules and a separate set of numbered egress rules. When determining whether
a packet should be allowed in or out of a subnet associated with the ACL, Amazon VPC processes the
entries in the ACL according to the rule numbers, in ascending order.
We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number
them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing
ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete
the old one.
For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User
Guide.
Replace Network Acl Entry
Replace Network Acl Entry request
Replace Network Acl Entry Response from the service
Replaces an entry (i.e., rule) in a network ACL. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Delete Network Acl Entry
Delete Network Acl Entry request
Delete Network Acl Entry Response from the service
Deletes an ingress or egress entry (i.e., rule) from a network ACL. For more information about network
ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.
Implements the Dispose pattern for the AmazonEC2Client
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an
AmazonEC2 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonEC2 Configuration Object
Constructs an AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an
AmazonEC2 Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The AmazonEC2 Configuration Object
Activate License
Activate License request
Activate License Response from the service
Activates a specific number of licenses for a 90-day period.
Activations can be done against a specific license ID.
Allocate Address
Allocate Address request
Allocate Address Response from the service
The AllocateAddress operation acquires an elastic
IP address for use with your account.
Associate Address
Associate Address request
Associate Address Response from the service
The AssociateAddress operation associates an
elastic IP address with an instance.
If the IP address is currently
assigned to another instance, the IP
address is assigned to the new
instance. This is an idempotent operation. If you enter
it more than once, Amazon EC2 does not return an error.
Attach Volume
Attach Volume request
Attach Volume Response from the service
Attach a previously created volume to a running
instance.
Authorize Security Group Ingress
Authorize Security Group Ingress request
Authorize Security Group Ingress Response from the service
The AuthorizeSecurityGroupIngress operation adds
permissions to a security group.
Permissions are specified by the IP
protocol (TCP, UDP or ICMP), the source of
the request (by IP range
or an Amazon EC2 user-group pair), the
source and destination port ranges (for TCP and UDP),
and the ICMP codes and types (for ICMP).
When authorizing ICMP, -1 can be used as a wildcard in the
type and code fields.
Permission changes are propagated to instances within the
security group as quickly as possible. However, depending on the
number of instances, a small
delay might occur.
When authorizing a user/group pair permission, GroupName,
SourceSecurityGroupName and
SourceSecurityGroupOwnerId must be
specified. When authorizing a CIDR
IP permission, GroupName, IpProtocol, FromPort, ToPort and
CidrIp must be specified. Mixing these two types of parameters is
not allowed.
Bundle Instance
Bundle Instance request
Bundle Instance Response from the service
The BundleInstance operation request that an
instance is bundled the next time it boots.
The bundling process creates a new image from a running instance and
stores the AMI data in S3. Once bundled, the image must be registered in the
normal way using the RegisterImage API.
Cancel Bundle Task
Cancel Bundle Task request
Cancel Bundle Task Response from the service
CancelBundleTask operation cancels a pending or
in-progress bundling task. This is an asynchronous
call and it make
take a while for the task to be cancelled.
If a task is cancelled
while it is storing items,
there may be parts of the incomplete AMI
stored in S3.
It is up to the caller to clean up these parts from S3.
Confirm Product Instance
Confirm Product Instance request
Confirm Product Instance Response from the service
The ConfirmProductInstance operation returns true
if the specified product code
is attached to the specified instance.
The operation returns false if the
product code is not attached to the
instance.
The ConfirmProductInstance operation can only be executed
by the owner of the
AMI. This feature is useful when an AMI owner is
providing support and wants to
verify whether a user's instance is eligible.
Create Image
Create Image request
Create Image Response from the service
Creates an AMI that uses an Amazon EBS root
device from a "running" or "stopped" instance.
AMIs that use an Amazon EBS root device boot
faster than AMIs that use instance stores. They
can be up to 1 TiB in size, use storage that
persists on instance failure, and can be stopped and started.
Create Key Pair
Create Key Pair request
Create Key Pair Response from the service
The CreateKeyPair operation creates a new 2048
bit RSA key pair and returns a
unique ID that can be used to reference
this key pair when launching new
instances. For more information, see
RunInstances.
Create Placement Group
Create Placement Group request
Create Placement Group Response from the service
The CreateKeyPair operation creates a new 2048
bit RSA key pair and returns a
unique ID that can be used to reference
this key pair when launching new
instances. For more information, see
RunInstances.
Create Security Group
Create Security Group request
Create Security Group Response from the service
The CreateSecurityGroup operation creates a new
security group.
Every instance is launched in a security group. If no security group is
specified during launch, the instances are launched in the default
security group. Instances within the same security
group have unrestricted network access to each other. Instances will
reject network access attempts from other instances in a different
security group. As the owner of instances you can grant or revoke
specific permissions using the AuthorizeSecurityGroupIngress
and RevokeSecurityGroupIngress operations.
Create Snapshot
Create Snapshot request
Create Snapshot Response from the service
Create a snapshot of the volume identified by
volume ID. A volume does not have to be detached
at the time the snapshot is taken.
Important Note:
Snapshot creation requires that the
system is in a consistent state.
For instance, this means that if
taking a snapshot of a database, the
tables must be read-only locked
to ensure that the snapshot will not contain a
corrupted version of the database. Therefore,
be careful when using this API to ensure that
the system remains in the consistent state until the create
snapshot status has returned.
Create Tags
Create Tags request
Create Tags Response from the service
Adds or overwrites one or more tags for the specified 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.
Create Volume
Create Volume request
Create Volume Response from the service
Initializes an empty volume of a given size
Deactivate License
Deactivate License request
Deactivate License Response from the service
Deactivates a specific number of licenses.
Deactivations can be done against a specific license ID
after they have persisted for at least a 90-day period.
Delete Key Pair
Delete Key Pair request
Delete Key Pair Response from the service
The DeleteKeyPair operation deletes a key pair.
Delete Placement Group
Delete Placement Group request
Delete Placement Group Response from the service
The DeletePlacementGroup operation deletes a placement group.
Delete Security Group
Delete Security Group request
Delete Security Group Response from the service
The DeleteSecurityGroup operation deletes a
security group.
Note:
If you attempt to delete a security group that
contains instances, a fault is returned.
If you attempt to delete a
security group that is referenced by
another security group, a fault
is returned. For example, if security group B has a
rule that allows access from security group A, security group A
cannot be deleted until the allow rule is removed.
Delete Snapshot
Delete Snapshot request
Delete Snapshot Response from the service
Deletes the snapshot identitied by snapshotId.
Delete Tags
Delete Tags request
Delete Tags Response from the service
Deletes the snapshot identitied by snapshotId.
Delete Volume
Delete Volume request
Delete Volume Response from the service
Deletes a previously created volume. Once
successfully deleted, a new
volume can be created with the same name.
Deregister Image
Deregister Image request
Deregister Image Response from the service
The DeregisterImage operation deregisters an AMI.
Once deregistered, instances
of the AMI can no longer be launched.
Describe Addresses
Describe Addresses request
Describe Addresses Response from the service
The DescribeAddresses operation lists elastic IP
addresses assigned to your account.
Describe Availability Zones
Describe Availability Zones request
Describe Availability Zones Response from the service
The DescribeAvailabilityZones operation describes
availability zones that are
currently available to the account and
their states.
Availability zones are not the same across accounts.
The availability zone
us-east-1a for account A is not necessarily the
same as us-east-1a for account
B. Zone assignments are mapped
independently for each account.
Describe Bundle Tasks
Describe Bundle Tasks request
Describe Bundle Tasks Response from the service
The DescribeBundleTasks operation describes in-progress
and recent bundle tasks. Complete and failed tasks are
removed from the list a short time after completion.
If no bundle ids are given, all bundle tasks are returned.
Describe Licenses
Describe Licenses request
Describe Licenses Response from the service
Provides details of a user's registered licenses. Zero or more IDs
may be specified on the call. When one or more license IDs are
specified, only data for the specified IDs are returned.
Describe Placement Groups
Describe Placement Groups request
Describe Placement Groups Response from the service
Returns information about one or more PlacementGroup instances in a
user's account.
Describe Snapshot Attribute
Describe Snapshot Attribute request
Describe Snapshot Attribute Response from the service
Returns information about an attribute of a snapshot.
Only one attribute can be specified per call.
Describe Image Attribute
Describe Image Attribute request
Describe Image Attribute Response from the service
The DescribeImageAttribute operation returns
information about an attribute of
an AMI. Only one attribute can be
specified per call.
Describe Images
Describe Images request
Describe Images Response from the service
The DescribeImages operation returns information
about AMIs, AKIs, and ARIs
available to the user. Information returned
includes image type, product codes,
architecture, and kernel and RAM
disk IDs. Images available to the user include
public images
available for any user to launch, private images owned
by the user making the request, and private images
owned by other users for which the
user has explicit launch permissions.
Launch permissions fall into three categories:
Public:
The owner of the AMI granted launch permissions for the AMI to the all
group. All users have launch permissions for these AMIs.
Explicit:
The owner of the AMI granted launch permissions to a specific user.
Implicit:
A user has implicit launch permissions for all AMIs he or she owns.
The list of AMIs returned can be modified by specifying AMI IDs, AMI
owners, or users with launch permissions. If no options are specified,
Amazon EC2 returns all AMIs for which the user has launch permissions.
If you specify one or more AMI IDs, only AMIs that have the specified
IDs are returned. If you specify an invalid AMI ID, a fault is returned.
If you specify an AMI ID for which you do not have access, it will not
be included in the returned results.
If you specify one or more AMI
owners, only AMIs from the specified
owners and for which you have
access are returned. The results can include the
account IDs of the specified owners, amazon for
AMIs owned by Amazon or self for AMIs that you own.
If you specify a list of executable users, only users
that have launch
permissions for the AMIs are returned. You can
specify account IDs
(if you own
the AMI(s)), self for AMIs for which
you own or have explicit
permissions, or
all for public AMIs.
Note:
Deregistered images are included in the returned results for an
unspecified
interval after deregistration.
Describe Instances
Describe Instances request
Describe Instances Response from the service
The DescribeInstances operation returns
information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns
information for those instances. If you do not specify
instance IDs, Amazon EC2 returns information for
all relevant instances. If you specify an invalid
instance ID, a fault is returned. If you specify an instance
that you do not own, it will
not be included in the returned results.
Recently terminated instances might appear in the
returned results. This interval is usually less than one hour.
Describe Regions
Describe Regions request
Describe Regions Response from the service
The DescribeRegions operation describes regions
zones that are
currently available to the account.
Describe Reserved Instances
Describe Reserved Instances request
Describe Reserved Instances Response from the service
The DescribeReservedInstances operation describes
Reserved Instances
that were purchased for use with your account.
Describe Reserved Instances Offerings
Describe Reserved Instances Offerings request
Describe Reserved Instances Offerings Response from the service
The DescribeReservedInstancesOfferings operation
describes Reserved
Instance offerings that are available for
purchase. With Amazon EC2
Reserved Instances, you purchase the right
to launch Amazon EC2 instances
for a period of time (without getting
insufficient capacity errors) and
pay a lower usage rate for the
actual time used.
Describe Key Pairs
Describe Key Pairs request
Describe Key Pairs Response from the service
The DescribeKeyPairs operation returns information about key pairs
available to you. If you specify key pairs, information about
those key pairs is returned. Otherwise,
information for all registered key pairs is returned.
Describe Security Groups
Describe Security Groups request
Describe Security Groups Response from the service
The DescribeSecurityGroups operation returns
information about security groups
that you own.
If you specify security group names, information about those security
group is returned. Otherwise, information for all security group is
returned. If you specify a group that does not exist, a fault is returned.
Describe Snapshots
Describe Snapshots request
Describe Snapshots Response from the service
Describes the indicated snapshots, or in lieu of
that, all snapshots owned by the caller.
Describe Tags
Describe Tags request
Describe Tags Response from the service
Describes the indicated snapshots, or in lieu of
that, all snapshots owned by the caller.
Describe Volumes
Describe Volumes request
Describe Volumes Response from the service
Describes the status of the indicated or, in lieu
of any specified, all
volumes belonging to the caller.
Volumes that
have been deleted are not described.
Detach Volume
Detach Volume request
Detach Volume Response from the service
Detach a previously attached volume from a
running instance.
Disassociate Address
Disassociate Address request
Disassociate Address Response from the service
The DisassociateAddress operation disassociates
the specified elastic IP
address from the instance to which it is
assigned. This is an idempotent
operation. If you enter it more than
once, Amazon EC2 does not
return an error.
Get Password Data
Get Password Data request
Get Password Data Response from the service
Retrieves the encrypted administrator password
for the instances running
Windows.
Get Console Output
Get Console Output request
Get Console Output Response from the service
The GetConsoleOutput operation retrieves console
output for the specified instance.
Instance console output is buffered
and posted shortly after instance boot,
reboot, and termination. Amazon EC2 preserves the
most recent 64 KB output which will be
available for at least one hour after the most recent post.
Import Key Pair
Import Key Pair request
Import Key Pair Response from the service
The GetConsoleOutput operation retrieves console
output for the specified instance.
Instance console output is buffered
and posted shortly after instance boot,
reboot, and termination. Amazon EC2 preserves the
most recent 64 KB output which will be
available for at least one hour after the most recent post.
Modify Snapshot Attribute
Modify Snapshot Attribute request
Modify Snapshot Attribute Response from the service
Adds or remove permission settings for the
specified snapshot.
Modify Image Attribute
Modify Image Attribute request
Modify Image Attribute Response from the service
The ModifyImageAttribute operation modifies an
attribute of an AMI.
Purchase Reserved Instances Offering
Purchase Reserved Instances Offering request
Purchase Reserved Instances Offering Response from the service
The PurchaseReservedInstancesOffering operation
purchases a Reserved Instance for use with your account.
With Amazon EC2 Reserved Instances, you purchase the
right to launch Amazon EC2 instances for a period of time
(without getting insufficient capacity errors) and pay a
lower usage rate for the actual time used.
Reboot Instances
Reboot Instances request
Reboot Instances Response from the service
The RebootInstances operation requests a reboot
of one or more instances. This
operation is asynchronous; it only
queues a request to reboot the specified
instance(s). The operation
will succeed if the instances are valid
and belong to the user.
Requests to reboot terminated instances are ignored.
Register Image
Register Image request
Register Image Response from the service
The RegisterImage operation registers an AMI with
Amazon EC2. Images must be
registered before they can be launched. For
more information, see RunInstances.
Each AMI is associated with an
unique ID which is provided by the Amazon EC2
service through the RegisterImage operation.
During registration, Amazon EC2
retrieves the specified image manifest from
Amazon S3 and verifies that the image
is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2.
Any modifications to an image in Amazon S3 invalidates this
registration. If you make changes to an image, deregister the
previous image and register the new
image. For more information, see DeregisterImage.
Release Address
Release Address request
Release Address Response from the service
The ReleaseAddress operation releases an elastic
IP address associated with your account.
Note:
Releasing an IP address
automatically disassociates it from any instance with
which it is associated. For more information, see
DisassociateAddress.
Important:
After releasing an elastic IP address, it is released to the IP
address pool and might no longer be available to your account. Make
sure to update your DNS records and any servers or devices that
communicate with the address.
If you run this operation on an elastic
IP address that is already released,
the address might be assigned to
another account which will cause
Amazon EC2 to return an error.
Reset Snapshot Attribute
Reset Snapshot Attribute request
Reset Snapshot Attribute Response from the service
Resets permission settings for the specified
snapshot.
Reset Image Attribute
Reset Image Attribute request
Reset Image Attribute Response from the service
The ResetImageAttribute operation resets an
attribute of an AMI to its default value.
Note:
The productCodes
attribute cannot be reset.
Revoke Security Group Ingress
Revoke Security Group Ingress request
Revoke Security Group Ingress Response from the service
The RevokeSecurityGroupIngress operation revokes
permissions from a security
group. The permissions used to revoke must
be specified using the same values
used to grant the permissions.
Permissions are specified by IP protocol (TCP, UDP, or ICMP), the
source of the request (by IP range or an Amazon EC2 user-group pair),
the source and destination port ranges (for TCP and UDP), and the ICMP
codes and types (for ICMP).
Permission changes are quickly propagated
to instances within the security
group. However, depending on the
number of instances in the group, a
small delay is might occur, .
When revoking a user/group pair permission, GroupName,
SourceSecurityGroupName
and SourceSecurityGroupOwnerId must be
specified. When authorizing a
CIDR IP permission, GroupName,
IpProtocol, FromPort, ToPort and CidrIp must be
specified. Mixing these two types of parameters is not allowed.
Run Instances
Run Instances request
Run Instances Response from the service
The RunInstances operation launches a specified
number of instances.
If Amazon EC2 cannot launch the minimum number
AMIs you request, no instances
launch. If there is insufficient
capacity to launch the maximum number of AMIs
you request, Amazon EC2
launches as many as possible to satisfy the
requested maximum values.
Every instance is launched in a security group. If you do not
specify a security group at launch, the instances start in your
default security group. For more information on creating security
groups, see CreateSecurityGroup.
An optional instance type can be
specified. For information about
instance types, see Instance Types.
You can provide an optional key pair ID for each image in the launch
request (for more information, see CreateKeyPair). All instances that
are created from images that use this key pair will have access to the
associated public key at boot. You can use this key to provide secure
access to an instance of an image on a per-instance basis. Amazon EC2
public images use this feature to provide secure access without passwords.
Important:
Launching public images without a key pair ID will leave them inaccessible.
The public key material is made available to the instance at boot
time by placing it in the openssh_id.pub file on a logical device that is exposed
to the instance as /dev/sda2 (the ephemeral store). The format of this
file is suitable for use as an entry within ~/.ssh/authorized_keys (the
OpenSSH format). This can be done at boot (e.g., as part of rc.local)
allowing for secure access without passwords.
Optional user data can be provided in the launch request. All instances that
collectively comprise the launch request have access to this data
For more information, see Instance Metadata.
Note:
If any of the AMIs have a product code attached for which the user has
not subscribed, the RunInstances call will fail.
Important:
We strongly recommend using
the 2.6.18 Xen stock kernel with the
c1.medium and c1.xlarge
instances. Although the default Amazon EC2 kernels will work, the
new kernels provide greater stability and performance for these
instance types. For more information about kernels, see Kernels, RAM
Disks, and Block Device Mappings.
Stop Instances
Stop Instances request
Stop Instances Response from the service
Stops an instance that uses an Amazon EBS volume
as its root device. 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.
Start Instances
Start Instances request
Start Instances Response from the service
Starts an instance that uses an Amazon EBS volume as its root device.
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.
Modify Instance Attribute
Modify Instance Attribute request
Modify Instance Attribute Response from the service
Modifies an attribute of an instance.
Reset Instance Attribute
Reset Instance Attribute request
Reset Instance Attribute Response from the service
Resets an attribute of an instance to its default
value.
Describe Instance Attribute
Describe Instance Attribute request
Describe Instance Attribute Response from the service
Returns information about an attribute of an
instance. Only one attribute
can be specified per call.
Terminate Instances
Terminate Instances request
Terminate Instances Response from the service
The TerminateInstances operation shuts down one
or more instances. This
operation is idempotent; if you terminate an
instance more than
once, each call
will succeed.
Terminated instances
will remain visible after termination (approximately one hour).
Monitor Instances
Monitor Instances request
Monitor Instances Response from the service
Enables monitoring for a running instance.
Unmonitor Instances
Unmonitor Instances request
Unmonitor Instances Response from the service
Disables monitoring for a running instance.
Describe Vpn Connections
Describe Vpn Connections request
Describe Vpn Connections Response from the service
Gives you information about your VPN connections.
Important -
We strongly recommend you use HTTPS when calling this operation because the
response contains sensitive cryptographic information for configuring your customer gateway.
You can filter the results to return information only about VPN connections
that match criteria you specify. For example, you could ask to get information
about a particular VPN connection (or all) only if the VPN's state is pending
or available. You can specify multiple filters (e.g., the VPN connection is
associated with a particular VPN gateway, and the gateway's state is
pending or available). The result includes information for a particular
VPN connection only if the VPN connection matches all your filters.
If there's no match, no special message is returned; the response is
simply empty.
Describe Subnets
Describe Subnets request
Describe Subnets Response from the service
Gives you information about your subnets. You can filter the results to
return information only about subnets that match criteria you specify.
For example, you could ask to get information about a particular subnet
(or all) only if the subnet's state is available. You can specify multiple
filters (e.g., the subnet is in a particular VPC, and the subnet's state is
available). The result includes information for a particular subnet only
if the subnet matches all your filters. If there's no match, no special
message is returned; the response is simply empty. The following table
shows the available filters.
Detach Vpn Gateway
Detach Vpn Gateway request
Detach Vpn Gateway Response from the service
Detaches a VPN 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 VPN gateway
has been completely detached from a VPC by describing the VPN gateway
(any attachments to the VPN gateway are also described).
You must wait for the attachment's state to switch to detached before you can
delete the VPC or attach a different VPC to the VPN gateway.
Describe Vpcs
Describe Vpcs request
Describe Vpcs Response from the service
Gives you information about your VPCs. You can filter the results to return
information only about VPCs that match criteria you specify. For example,
you could ask to get information about a particular VPC or VPCs (or all your VPCs)
only if the VPC's state is available. You can specify multiple filters (e.g.,
the VPC uses one of several sets of DHCP options, and the VPC's state is available).
The result includes information for a particular VPC only if the VPC
matches all your filters. If there's no match, no special message is
returned; the response is simply empty.
Delete Customer Gateway
Delete Customer Gateway request
Delete Customer Gateway Response from the service
Deletes a customer gateway. You must delete the VPN connection before
deleting the customer gateway.
AWS might delete any customer gateway if you leave it inactive for an extended
period of time (inactive means that there's no VPN connection in use with the
customer gateway).
Attach Vpn Gateway
Attach Vpn Gateway request
Attach Vpn Gateway Response from the service
Attaches a VPN gateway to a VPC. This is the last step required to get your
VPC fully connected to your data center before launching instances in it.
For more information, go to Process for Using Amazon VPC in the Amazon Virtual
Private Cloud Developer Guide.
Delete Dhcp Options
Delete Dhcp Options request
Delete Dhcp Options Response from the service
Deletes a set of DHCP options that you specify. Amazon VPC returns an error if the
set of options you specify is currently associated with a VPC. You can disassociate
the set of options by associating either a new set of options or the default options with the VPC.
Delete Subnet
Delete Subnet request
Delete Subnet Response from the service
Deletes a subnet from a VPC. You must terminate all running instances in the
subnet before deleting it, otherwise Amazon VPC returns an error.
AWS might delete any subnet if you leave it inactive for an extended period
of time (inactive means that there are no running Amazon EC2 instances in the subnet).
Create Vpc
Create Vpc request
Create Vpc Response from the service
Creates a VPC with the CIDR block you specify. The smallest VPC you can create
uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask
(16,384 IP addresses). To help you decide how big to make your VPC, go
to the topic about creating VPCs in the Amazon Virtual Private Cloud
Developer Guide.
By default, each instance you launch in the VPC has the default DHCP options
(the standard EC2 host name, no domain name, no DNS server, no NTP server, and
no NetBIOS server or node type).
AWS might delete any VPC that you create with this operation if you leave it inactive
for an extended period of time (inactive means that there are no running Amazon EC2
instances in the VPC).
Create Customer Gateway
Create Customer Gateway request
Create Customer Gateway Response from the service
Provides information to AWS about your customer gateway device.
The customer gateway is the appliance at your end of the VPN connection
(compared to the VPN gateway, which is the device at the AWS side of the VPN
connection). AWS might delete any customer gateway that you create with this
operation if you leave it inactive for an extended period of time (inactive means
that there's no VPN connection in use with the customer gateway).
You must provide the Internet-routable IP address of the customer gateway's external
interface. The IP address must be static and can't be behind a device performing
network address translation (NAT).
You must also provide the device's Border Gateway Protocol (BGP) Autonomous
System Number (ASN). You can use an existing ASN assigned to your network.
If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
For more information about ASNs, go to the Wikipedia article -
http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29.
Create Vpn Gateway
Create Vpn Gateway request
Create Vpn Gateway Response from the service
Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint for
your VPN connection. You can create a VPN gateway before creating the VPC
itself. AWS might delete any VPN gateway that you create with this operation
if you leave it inactive for an extended period of time (inactive means
that there's no VPN connection in use with the VPN gateway).
Delete Vpc
Delete Vpc request
Delete Vpc Response from the service
Deletes a VPC. You must terminate all running instances and delete all
subnets before deleting the VPC, otherwise Amazon VPC returns an error.
AWS might delete any VPC if you leave it inactive for an extended period of time
(inactive means that there are no running Amazon EC2 instances in the VPC).
Associate Dhcp Options
Associate Dhcp Options request
Associate Dhcp Options Response from the service
Associates a set of DHCP options (that you've previously created) with the specified VPC.
Or, associates the default DHCP options with the VPC. The default set consists of the standard
EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type.
After you associate the options with the VPC, any existing instances and all new instances
that you launch in that VPC use the options. For more information about the supported DHCP
options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual
Private Cloud Developer Guide.
Describe Vpn Gateways
Describe Vpn Gateways request
Describe Vpn Gateways Response from the service
Gives you information about your VPN gateways. You can filter the results to return
information only about VPN gateways that match criteria you specify. For example,
you could ask to get information about a particular VPN gateway (or all) only if the
gateway's state is pending or available. You can specify multiple filters (e.g., the
VPN gateway is in a particular Availability Zone and the gateway's state is pending or
available). The result includes information for a particular VPN gateway only if the
gateway matches all your filters. If there's no match, no special message is returned;
the response is simply empty.
Create Subnet
Create Subnet request
Create Subnet Response from the service
Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC.
If you add more than one subnet to a VPC, they're set up in a star topology with
a logical router in the middle. If you feel you need more than 20 subnets, you can
request more by going to http://aws.amazon.com/contact-us/vpc-request/.
When you create each subnet, you provide the VPC ID and the CIDR block you
want for the subnet. Once you create a subnet, you can't change its CIDR block.
The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you
want only a single subnet in the VPC), or a subset of the VPC's CIDR block.
If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap.
The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses),
and the largest uses a /18 netmask (16,384 IP addresses).
Important -
AWS reserves both the first four and the last IP address in each subnet's CIDR block.
They're not available for use.
AWS might delete any subnet you create with this operation if you leave it inactive
for an extended period of time (inactive means that there are no running Amazon EC2
instances in the subnet).
Delete Vpn Connection
Delete Vpn Connection request
Delete Vpn Connection Response from the service
Deletes a VPN connection. Use this if you want to delete a VPC and
all its associated components. Another reason to use this operation
is if you believe the tunnel credentials for your VPN connection have
been compromised. In that situation, you can delete the VPN connection
and create a new one that has new keys, without needing to delete the
VPC or VPN gateway. If you create a new VPN connection, you must
reconfigure the customer gateway using the new configuration
information returned with the new VPN connection ID.
If you're deleting the VPC and all its associated parts, we recommend you
detach the VPN gateway from the VPC and delete the VPC before deleting
the VPN connection.
Delete Vpn Gateway
Delete Vpn Gateway request
Delete Vpn Gateway Response from the service
Deletes a VPN gateway. Use this when you want to delete a VPC and all
its associated components because you no longer need them. We recommend
that before you delete a VPN gateway, you detach it from the VPC and
delete the VPN connection. Note that you don't need to delete the VPN
gateway if you just want to delete and re-create the VPN connection
between your VPC and data center.
AWS might delete any VPN gateway if you leave it inactive for an extended period of time
(inactive means that there's no VPN connection in use with the VPN gateway).
Describe Customer Gateways
Describe Customer Gateways request
Describe Customer Gateways Response from the service
Gives you information about your customer gateways. You can filter the results to return
information only about customer gateways that match criteria you specify. For example,
you could ask to get information about a particular customer gateway (or all) only if
the gateway's state is pending or available. You can specify multiple filters (e.g.,
the customer gateway has a particular IP address for the Internet-routable external
interface, and the gateway's state is pending or available). The result includes
information for a particular customer gateway only if the gateway matches all your
filters. If there's no match, no special message is returned; the response is simply empty.
Create Vpn Connection
Create Vpn Connection request
Create Vpn Connection Response from the service
Creates a new VPN connection between an existing VPN gateway and customer
gateway. The only supported connection type is ipsec.1.
The response includes information that you need to configure your customer gateway,
in XML format. We recommend you use the command line version of this operation
(ec2-create-vpn-connection), which lets you get the configuration information
formatted in a friendlier way. For information about the command, go to
ec2-create-vpn-connection in the Amazon Virtual Private Cloud Command Line Reference.
Important -
We strongly recommend you use HTTPS when calling this operation because
the response contains sensitive cryptographic information for configuring
your customer gateway.
If you decide to shut down your VPN connection for any reason and then create a new
one, you must re-configure your customer gateway with the new information
returned from this call.
Describe Dhcp Options
Describe Dhcp Options request
Describe Dhcp Options Response from the service
Gives you information about one or more sets of DHCP options. You can specify
one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options).
The returned information consists of:
- The DHCP options set ID
- The options
Create Dhcp Options
Create Dhcp Options request
Create Dhcp Options Response from the service
Creates a set of DHCP options that you can then associate with one or more VPCs,
causing all existing and new instances that you launch in those VPCs to use the
set of DHCP options. The following table lists the individual DHCP options you can
specify. For more information about the options, go to RFC 2132 - http://www.ietf.org/rfc/rfc2132.txt
Request Spot Instances
Request Spot Instances request
Request Spot Instances Response from the service
Creates a Spot Instance request. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Describe Spot Instance Requests
Describe Spot Instance Requests request
Describe Spot Instance Requests Response from the service
Describes Spot Instance requests. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Cancel Spot Instance Requests
Cancel Spot Instance Requests request
Cancel Spot Instance Requests Response from the service
Cancels Spot Instance requests. Spot Instances are instances that automatically launch when your
request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Describe Spot Price History
Describe Spot Price History request
Describe Spot Price History Response from the service
Describes historical pricing for Spot Instances. Spot Instances are instances that automatically launch
when your request price exceeds the Spot Price that Amazon EC2 periodically calculates.
Create Spot Datafeed Subscription
Create Spot Datafeed Subscription request
Create Spot Datafeed Subscription Response from the service
Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can
create one data feed per account.
Describe Spot Datafeed Subscription
Describe Spot Datafeed Subscription request
Describe Spot Datafeed Subscription Response from the service
Describes the data feed for Spot Instances.
Delete Spot Datafeed Subscription
Delete Spot Datafeed Subscription request
Delete Spot Datafeed Subscription Response from the service
Deletes the data feed for Spot Instances.
Cancel Conversion Task
Cancel Conversion Task request
Cancel Conversion Task Response from the service
Cancels an active conversion task. The task can be the import of an instance or volume. The command removes all artifacts of
the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
Describe Conversion Tasks
Describe Conversion Tasks request
Describe Conversion Tasks Response from the service
Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Import Instance
Import Instance request
Import Instance Response from the service
Creates a new import instance task using metadata from the specified disk image. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Import Volume
Import Volume request
Import Volume Response from the service
Creates a new import volume task using metadata from the specified disk image. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
Authorize Security Group Egress
Authorize Security Group Egress request
Authorize Security Group Egress Response from the service
This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action adds one or more egress rules to a VPC security group. Specifically, this permits instances
in a security group to send traffic to either one or more destination CIDR IP address ranges, or to one or
more destination security groups in the same VPC.
Each rule consists of the protocol (e.g., TCP), plus either a CIDR range, or a source group. For the TCP
and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you
must also specify the ICMP type and code.You can use -1 as a wildcard for the ICMP type or code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Adding hundreds of rules to a security group might cause problems when you access the instance.
We recommend you condense your rules as much as possible.
Revoke Security Group Egress
Revoke Security Group Egress request
Revoke Security Group Egress Response from the service
This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action removes one or more egress rules from a VPC security group. The values that you specify in
the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be
revoked.
Each rule consists of the protocol, and the CIDR range or destination security group. For the TCP and
UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you
must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Create Internet Gateway
Create Internet Gateway request
Create Internet Gateway Response from the service
Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you then attach
it to a VPC using AttachInternetGateway. For more information about your VPC and Internet gateway,
go to Amazon Virtual Private Cloud User Guide.
Describe Internet Gateways
Describe Internet Gateways request
Describe Internet Gateways Response from the service
Gives you information about your Internet gateways.You can filter the results to return information only
about Internet gateways that match criteria you specify. For example, you could get information only
about gateways with particular tags. The Internet gateway must match at least one of the specified values
for it to be included in the results.
You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged
with a particular value). The result includes information for a particular Internet gateway only if the gateway
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Internet Gateway
Delete Internet Gateway request
Delete Internet Gateway Response from the service
Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For
more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
Attach Internet Gateway
Attach Internet Gateway request
Attach Internet Gateway Response from the service
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For
more information about your VPC and Internet gateway, go to the Amazon Virtual Private Cloud User
Guide.
Detach Internet Gateway
Detach Internet Gateway request
Detach Internet Gateway Response from the service
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. For more information about your
VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
For more information about Amazon Virtual Private Cloud and Internet gateways, go to the Amazon Virtual
Private Cloud User Guide.
Create Route Table
Create Route Table request
Create Route Table Response from the service
Creates a new route table within a VPC. After you create a new route table, you can add routes and
associate the table with a subnet. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Describe Route Tables
Describe Route Tables request
Describe Route Tables Response from the service
Gives you information about your route tables.You can filter the results to return information only about
tables that match criteria you specify. For example, you could get information only about a table associated
with a particular subnet.You can specify multiple values for the filter. The table must match at least one
of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular
subnet). The result includes information for a particular table only if it matches all your filters. If there's
no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Route Table
Delete Route Table request
Delete Route Table Response from the service
Deletes a route table from a VPC. The route table must not be associated with a subnet.You can't delete
the main route table. For more information about route tables, go to Route Tables in the Amazon Virtual
Private Cloud User Guide.
Associate Route Table
Associate Route Table request
Associate Route Table Response from the service
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 if you want to disassociate the route table
from the subnet later. A route table can be associated with multiple subnets.
For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User
Guide.
Replace Route Table Association
Replace Route Table Association request
Replace Route Table Association Response from the service
Changes the route table associated with a given subnet in a VPC. After you execute this action, the subnet
uses the routes in the new route table it's associated with. For more information about route tables, go
to Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use this 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 that you want to be the new main route table.
Disassociate Route Table
Disassociate Route Table request
Disassociate Route Table Response from the service
Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead it uses the
routes in the VPC's main route table. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Create Route
Create Route request
Create Route Response from the service
Creates a new route in a route table within a VPC. The route's target can be either a gateway attached
to the VPC or a NAT instance in the VPC.
When determining how to route traffic, we use the route with the most specific match. For example, let's
say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific,
so we use that route to determine where to target the traffic.
For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User
Guide.
Replace Route
Replace Route request
Replace Route Response from the service
Replaces an existing route within a route table in a VPC. For more information about route tables, go to
Route Tables in the Amazon Virtual Private Cloud User Guide.
Delete Route
Delete Route request
Delete Route Response from the service
Deletes a route from a route table in a VPC. For more information about route tables, go to Route Tables
in the Amazon Virtual Private Cloud User Guide.
Create Network Acl
Create Network Acl request
Create Network Acl Response from the service
Creates a new network ACL in a VPC. Network ACLs provide an optional layer of security (on top of
security groups) for the instances in your VPC. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Describe Network Acls
Describe Network Acls request
Describe Network Acls Response from the service
Gives you information about the network ACLs in your VPC.You can filter the results to return information
only about ACLs that match criteria you specify. For example, you could get information only the ACL
associated with a particular subnet. The ACL must match at least one of the specified values for it to be
included in the results.
You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress
entry that denies traffic to a particular port). The result includes information for a particular ACL only if it
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Delete Network Acl
Delete Network Acl request
Delete Network Acl Response from the service
Deletes a network ACL from a VPC. The ACL must not have any subnets associated with it.You can't
delete the default network ACL. For more information about network ACLs, go to Network ACLs in the
Amazon Virtual Private Cloud User Guide.
Replace Network Acl Association
Replace Network Acl Association request
Replace Network Acl Association Response from the service
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, go to
Network ACLs in the Amazon Virtual Private Cloud User Guide.
Create Network Acl Entry
Create Network Acl Entry request
Create Network Acl Entry Response from the service
Creates an entry (i.e., rule) in a network ACL with a rule number you specify. Each network ACL has a
set of numbered ingress rules and a separate set of numbered egress rules. When determining whether
a packet should be allowed in or out of a subnet associated with the ACL, Amazon VPC processes the
entries in the ACL according to the rule numbers, in ascending order.
We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number
them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing
ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete
the old one.
For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User
Guide.
Replace Network Acl Entry
Replace Network Acl Entry request
Replace Network Acl Entry Response from the service
Replaces an entry (i.e., rule) in a network ACL. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Delete Network Acl Entry
Delete Network Acl Entry request
Delete Network Acl Entry Response from the service
Deletes an ingress or egress entry (i.e., rule) from a network ACL. For more information about network
ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.
Configure HttpClient with set of defaults as well as configuration
from AmazonEC2Config instance
Invoke request and return response
Look for additional error strings in the response and return formatted exception
Exponential sleep on failed request
Add authentication related and version parameters
Convert ActivateLicenseRequest to name value pairs
Convert AllocateAddressRequest to name value pairs
Convert AttachVpnGatewayRequest to name value pairs
Convert AssociateDhcpOptionsRequest to name value pairs
Convert AssociateAddressRequest to name value pairs
Convert AuthorizeSecurityGroupIngressRequest to name value pairs
Convert BundleInstanceRequest to name value pairs
Convert CancelBundleTaskRequest to name value pairs
Convert ConfirmProductInstanceRequest to name value pairs
Convert CreatePlacementGroupRequest to name value pairs
Convert CreateImageRequest to name value pairs
Convert CreateKeyPairRequest to name value pairs
Convert ImportKeyPairRequest to name value pairs
Convert CreateTagsRequest to name value pairs
Convert DescribeTagsRequest to name value pairs
Convert DeleteTagsRequest to name value pairs
Convert CreateSubnetRequest to name value pairs
Convert CreateVpnConnectionRequest to name value pairs
Convert CreateVpnGatewayRequest to name value pairs
Convert CreateDhcpOptionsRequest to name value pairs
Convert CreateVpcRequest to name value pairs
Convert CreateCustomerGatewayRequest to name value pairs
Convert CreateSecurityGroupRequest to name value pairs
Convert DeactivateLicenseRequest to name value pairs
Convert DeleteKeyPairRequest to name value pairs
Convert DeletePlacementGroupRequest to name value pairs
Convert DeleteVpcRequest to name value pairs
Convert DeleteVpnGatewayRequest to name value pairs
Convert DeleteVpnConnectionRequest to name value pairs
Convert DeleteDhcpOptionsRequest to name value pairs
Convert DeleteCustomerGatewayRequest to name value pairs
Convert DeleteSecurityGroupRequest to name value pairs
Convert DeleteSubnetRequest to name value pairs
Convert DescribeVpcsRequest to name value pairs
Convert DescribeVpnGatewaysRequest to name value pairs
Convert DescribeDhcpOptionsRequest to name value pairs
Convert DescribeVpnConnectionsRequest to name value pairs
Convert DescribeCustomerGatewaysRequest to name value pairs
Convert DescribeReservedInstancesOfferingsRequest to name value pairs
Convert DescribeReservedInstancesRequest to name value pairs
Convert DescribeSubnetsRequest to name value pairs
Convert PurchaseReservedInstancesOfferingRequest to name value pairs
Convert DeregisterImageRequest to name value pairs
Convert DescribeAddressesRequest to name value pairs
Convert DescribeAvailabilityZonesRequest to name value pairs
Convert DescribeBundleTasksRequest to name value pairs
Convert DescribeImageAttributeRequest to name value pairs
Convert DescribeInstanceAttributeRequest to name value pairs
Convert DescribeSnapshotAttributeRequest to name value pairs
Convert DescribeImagesRequest to name value pairs
Convert DescribeInstancesRequest to name value pairs
Convert DescribeKeyPairsRequest to name value pairs
Convert DescribeLicensesRequest to name value pairs
Convert DescribePlacementGroupsRequest to name value pairs
Convert DescribeSecurityGroupsRequest to name value pairs
Convert DisassociateAddressRequest to name value pairs
Convert GetConsoleOutputRequest to name value pairs
Convert GetPasswordDataRequest to name value pairs
Convert ModifyImageAttributeRequest to name value pairs
Convert ModifyInstanceAttributeRequest to name value pairs
Convert ModifySnapshotAttributeRequest to name value pairs
Convert MonitorInstancesRequest to name value pairs
Convert UnmonitorInstancesRequest to name value pairs
Convert RebootInstancesRequest to name value pairs
Convert RegisterImageRequest to name value pairs
Convert ReleaseAddressRequest to name value pairs
Convert ResetImageAttributeRequest to name value pairs
Convert ResetInstanceAttributeRequest to name value pairs
Convert ResetSnapshotAttributeRequest to name value pairs
Convert RevokeSecurityGroupIngressRequest to name value pairs
Convert RunInstancesRequest to name value pairs
Convert StopInstancesRequest to name value pairs
Convert StartInstancesRequest to name value pairs
Convert TerminateInstancesRequest to name value pairs
Convert DeleteVolumeRequest to name value pairs
Convert CreateVolumeRequest to name value pairs
Convert DescribeVolumesRequest to name value pairs
Convert DetachVolumeRequest to name value pairs
Convert DetachVpnGatewayRequest to name value pairs
Convert DescribeSnapshotsRequest to name value pairs
Convert DeleteSnapshotRequest to name value pairs
Convert CreateSnapshotRequest to name value pairs
Convert AttachVolumeRequest to name value pairs
Convert DescribeRegionsRequest to name value pairs
Convert RequestSpotInstancesRequest to name value pairs
Convert DescribeSpotInstanceRequestsRequest to name value pairs
Convert CancelSpotInstanceRequestsRequest to name value pairs
Convert DescribeSpotPriceHistoryRequest to name value pairs
Convert CreateSpotDatafeedSubscriptionRequest to name value pairs
Convert DescribeSpotDatafeedSubscriptionRequest to name value pairs
Convert DeleteSpotDatafeedSubscriptionRequest to name value pairs
Convert ImportInstanceRequest to name value pairs
Convert ImportVolumeRequest to name value pairs
Convert DescribeConversionTasksRequest to name value pairs
Convert CancelConversionTaskRequest to name value pairs
Convert AuthorizeSecurityGroupEgressRequest to name value pairs
Convert RevokeSecurityGroupEgressRequest to name value pairs
Convert CreateInternetGatewayRequest to name value pairs
Convert DescribeInternetGatewaysRequest to name value pairs
Convert DeleteInternetGatewayRequest to name value pairs
Convert AttachInternetGatewayRequest to name value pairs
Convert DetachInternetGatewayRequest to name value pairs
Convert CreateRouteTableRequest to name value pairs
Convert DescribeRouteTablesRequest to name value pairs
Convert DeleteRouteTableRequest to name value pairs
Convert AssociateRouteTableRequest to name value pairs
Convert ReplaceRouteTableAssociationRequest to name value pairs
Convert DisassociateRouteTableRequest to name value pairs
Convert CreateRouteRequest to name value pairs
Convert ReplaceRouteRequest to name value pairs
Convert DeleteRouteRequest to name value pairs
Convert CreateNetworkAclRequest to name value pairs
Convert DescribeNetworkAclsRequest to name value pairs
Convert DeleteNetworkAclRequest to name value pairs
Convert ReplaceNetworkAclAssociationRequest to name value pairs
Convert CreateNetworkAclEntryRequest to name value pairs
Convert ReplaceNetworkAclEntryRequest to name value pairs
Convert DeleteNetworkAclEntryRequest to name value pairs
Response Unmarshaller for PutMetricAlarm operation
Enable Alarm Actions Request Marshaller
AmazonCloudWatch exception
Constructs a new InvalidNextTokenException with the specified error
message.
Describes the error encountered.
Gets and Sets the Status property. Valid Values are InProgress and Completed
Gets and Sets the Id property which is the invalidation id
Gets and Sets the CreateTime property which is the date and time the invalidation request was first made.
Gets and Sets the InvalidationBatch property.
The ListOriginAccessIdentitiesRequest contains the parameters used for the ListOriginAccessIdentities operation.
All parameters to this request object are optional.
Sets the Marker property for this request.
All keys returned will be lexiographically after the marker.
the value that Marker is set to
this instance
Sets the MaxItems property for this request.
Limits the result set of keys to MaxItems.
the value that MaxItems is set to
this instance
Gets and sets the Marker property.
All keys returned will be lexiographically after the marker.
Gets and sets the MaxItems property.
Limits the result set of keys to MaxItems.
Contains a list of invalidation summaries.
For more information, please visit:
Gets and Sets the id of the invalidation.
Gets and Sets the status of the invalidation.
The GetOriginAccessIdentityConfigResponse contains the Origin Access Identity's configuration
and any headers returned by CloudFront.
Gets and Sets the OriginAccessIdentityConfig property.
Gets and sets the ETag property.
The Origin Access Identity's Configuration ETag is also
set if possible.
This class contains all the errors returned by the CloudFront service.
The errors are parsed from the Response XML provided by the HTTPWebResponse
embedded in the WebException thrown during Response retrieval.
XML Representation for this object
XML String
Gets and sets the Error property.
Gets and sets the RequestId property.
Response Unmarshaller for DeleteStack operation
The StackSummary Data Type
Sets the StackId property
The value to set for the StackId property
this instance
Sets the StackName property
The value to set for the StackName property
this instance
Sets the TemplateDescription property
The value to set for the TemplateDescription property
this instance
Sets the CreationTime property
The value to set for the CreationTime property
this instance
Sets the DeletionTime property
The value to set for the DeletionTime property
this instance
Sets the StackStatus property
The value to set for the StackStatus property
this instance
Unique stack identifier.
The name associated with the stack.
The template description of the template used to create the stack.
The time the stack was created.
The time the stack was deleted.
The status of the stack when it was deleted.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
The Output data type.
Sets the OutputKey property
The value to set for the OutputKey property
this instance
Sets the OutputValue property
The value to set for the OutputValue property
this instance
Sets the Description property
The value to set for the Description property
this instance
The key associated with the output.
The value associated with the output.
User defined description associated with the output.
Container for the parameters to the DescribeStackResource operation.
Returns the description for the specified resource in the specified stack. For deleted stacks, DescribeStackResource
returns resource information for up to 90 days after the stack has been deleted. You must specify StackName and
LogicalResourceId .
Sets the StackName property
The value to set for the StackName property
this instance
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
The name or the unique identifier associated with the stack. Default: There is no default value.
The logical name of the resource as specified in the template.
Default: There is on default value.
Container for the parameters to the DescribeStackEvents operation.
Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks
with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack's
event history, go to the AWS CloudFormation User Guide. NOTE:Events are returned, even if the stack never existed or
has been successfully deleted.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The name or the unique identifier associated with the stack.
Default: There is no default value.
String that identifies the start of the next list of events, if there is one.
Default: There is no default value.
Constraints:
-
Length
1 - 1024
Returns information about the UpdateAutoScalingGroup response metadata.
The UpdateAutoScalingGroup operation has a void result type.
Response Unmarshaller for UpdateAutoScalingGroup operation
Suspend Processes Request Marshaller
Response Unmarshaller for PutScheduledUpdateGroupAction operation
LaunchConfiguration Unmarshaller
EnabledMetric Unmarshaller
Response Unmarshaller for DeleteScheduledAction operation
Response Unmarshaller for CreateLaunchConfiguration operation
Returns information about the SetInstanceHealth response metadata.
The SetInstanceHealth operation has a void result type.
The output of the DescribeNotificationConfigurations action.
Adds elements to the NotificationConfigurations collection
The values to add to the NotificationConfigurations collection
this instance
Adds elements to the NotificationConfigurations collection
The values to add to the NotificationConfigurations collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The list of notification configurations.Should we be clearer?>
A string that is used to mark the start of the next batch of returned results for pagination.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the DescribeNotificationConfigurations operation.
Returns a list of notification actions associated with Auto Scaling groups for specified events.
Adds elements to the AutoScalingGroupNames collection
The values to add to the AutoScalingGroupNames collection
this instance
Adds elements to the AutoScalingGroupNames collection
The values to add to the AutoScalingGroupNames collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
The name of the Auto Scaling group.
A string that is used to mark the start of the next batch of returned results for pagination.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Maximum number of records to be returned.
Constraints:
-
Range
1 - 50
Container for the parameters to the DescribeMetricCollectionTypes operation.
Returns a list of metrics and a corresponding list of granularities for each metric.
A principal is an AWS account which is being allowed or denied access to a
resource through an access control policy. The principal is a property of the
Statement object, not directly the object.
The principal is A in the statement
"A has permission to do B to C where D applies."
In an access control policy statement, you can set the principal to all
authenticated AWS users through the member. This
is useful when you don't want to restrict access based on the identity of the
requester, but instead on other identifying characteristics such as the
requester's IP address.
The default Principal provider for AWS accounts.
Principal provider for Canonical User IDs.
Principal instance that includes all users, including anonymous users.
This is useful when you don't want to restrict access based on the
identity of the requester, but instead on other identifying
characteristics such as the requester's IP address.
Constructs a new principal with the specified AWS account ID.
An AWS account ID.
Gets and sets the provider for this principal, which indicates in what group of
users this principal resides.
Gets the unique ID for this principal.
The SendMessage action delivers a message to the specified queue.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the MessageBody property
The message to send. The maximum allowed message size is 8 KB.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification
(for more information, go to http://www.w3.org/TR/REC-xml/#charsets). If you send any characters not included in the
list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
this instance
Checks if MessageBody property is set
true if MessageBody property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the MessageBody property.
The message to send. The maximum allowed message size is 8 KB.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification
(for more information, go to http://www.w3.org/TR/REC-xml/#charsets). If you send any characters not included in the
list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
Returns a list of messages and metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
An element containing the information about the message.
Sets the MessageId property
Unique ID associated with the message.
this instance
Checks if MessageId property is set
true if MessageId property is set
Sets the ReceiptHandle property
A string associated with a specific instance of receiving the message.
this instance
Checks if ReceiptHandle property is set
true if ReceiptHandle property is set
Sets the MD5OfBody property
An MD5 digest of the non-URL-encoded message body string.
this instance
Checks if MD5OfBody property is set
true if MD5OfBody property is set
Sets the Body property
The message's contents (not URL encoded).
this instance
Checks if Body property is set
true if Body property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the MessageId property.
Unique ID associated with the message.
Gets and sets the ReceiptHandle property.
A string associated with a specific instance of receiving the message.
Gets and sets the MD5OfBody property.
An MD5 digest of the non-URL-encoded message body string.
Gets and sets the Body property.
The message's contents (not URL encoded).
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are
valid for twenty-four hours.
Sets the TopicArn property
The ARN of topic you want to subscribe to.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the Protocol property
The protocol you want to use. Supported protocols include:
- http -- delivery of JSON-encoded message via HTTP POST
- https -- delivery of JSON-encoded message via HTTPS POST
- email -- delivery of message via SMTP
- email-json -- delivery of JSON-encoded message via SMTP
- sqs -- delivery of JSON-encoded message to an Amazon SQS queue
this instance
Checks if Protocol property is set
true if Protocol property is set
Sets the Endpoint property
The endpoint that you want to receive notifications. Endpoints vary by protocol:
- For the http protocol, the endpoint is an URL beginning with "http://"
- For the https protocol, the endpoint is a URL beginning with "https://"
- For the email protocol, the endpoint is an e-mail address
- For the email-json protocol, the endpoint is an e-mail address
- For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
this instance
Checks if Endpoint property is set
true if Endpoint property is set
Gets and sets the TopicArn property.
The ARN of topic you want to subscribe to.
Gets and sets the Protocol property.
The protocol you want to use. Supported protocols include:
- http -- delivery of JSON-encoded message via HTTP POST
- https -- delivery of JSON-encoded message via HTTPS POST
- email -- delivery of message via SMTP
- email-json -- delivery of JSON-encoded message via SMTP
- sqs -- delivery of JSON-encoded message to an Amazon SQS queue
Gets and sets the Endpoint property.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
- For the http protocol, the endpoint is an URL beginning with "http://"
- For the https protocol, the endpoint is a URL beginning with "https://"
- For the email protocol, the endpoint is an e-mail address
- For the email-json protocol, the endpoint is an e-mail address
- For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
Encapsulates the metadata and result of the GetTopicAttributes action.
Checks if GetTopicAttributesResult property is set
true if GetTopicAttributesResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the GetTopicAttributesResult property.
Encapsulates the result of the GetTopicAttributes action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
The GetTopicAttribtues action returns all of the properties of a topic customers have created. Topic
properties returned might differ based on the authorization of the user.
Sets the TopicArn property
The ARN of the topic whose properties you want to get.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Gets and sets the TopicArn property.
The ARN of the topic whose properties you want to get.
Response Unmarshaller for GetSendQuota operation
Returns information about the GetSendQuotaResult response and response metadata.
Gets and sets the GetSendQuotaResult property.
Represents the user's current activity limits returned from a successful GetSendQuota request.
Configuration for accessing Amazon Simple Email Service service
Default constructor
Gets the ServiceVersion property.
Items represent individual objects that contain one or more attribute name-value pairs.
Sets the ItemName property
The name of the item.
this instance
Checks if ItemName property is set
true if ItemName property is set
Sets the Attribute property
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the ItemName property.
The name of the item.
Gets and sets the Attribute property.
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
The SetACLRequest contains the parameters used for the SetACL operation.
The BucketName is always required, the Key is optional and is to be set
if you want the ACL for an object instead of a bucket.
You can either set ACLs using CannedACLs or by providing an S3AccessControlList.
Required Parameters: BucketName
Optional Parameters: Key, CannedACL, ACL
Sets the BucketName property for this request.
This is either the S3 Bucket whose ACL you want to set,
or the S3 Bucket that has the S3 Object whose ACL
you want to set.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object whose ACL you
want to set.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the CannedACL property for this request.
The S3 Object or S3 Bucket will be set to this
CannedACL.
The Canned ACL to be set on the object
The request with the CannedACL set
Checks if the S3CannedACL property is set.
true if there is the S3CannedACL property is set.
Resets the S3CannedACL associated with this request
Sets the ACL property for this request.
The S3 Object or S3 Bucket will be set to this
S3AccessControlList.
The Canned ACL to be set on the object
The request with the ACL set
Checks if the ACL property is set.
true if ACL property is set.
Sets the VersionId property for this request.
This is the Version Id of the S3 Object for
which the ACL will be set. This property
is ignored if the ACL is to be set on a Bucket.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the CannedACL property.
Gets and sets the ACL property.
Gets and sets the VersionId property.
This is the Version Id of the S3 Object for
which the ACL will be set. This property
is ignored if the ACL is to be set on a Bucket.
The ListBucketsResponse contains the ListBucketsResult and
any headers or metadata returned by S3.
Gets the Bucket property. This property has been deprecated -
please use the Buckets property of ListBucketsResponse.
Gets the Buckets property.
Gets and sets the Owner property.
Response Unmarshaller for RevokeDBSecurityGroupIngress operation
Parameter Unmarshaller
DescribeOrderableDBInstanceOptionsResult Unmarshaller
Response Unmarshaller for DescribeOrderableDBInstanceOptions operation
DescribeDBParameterGroupsResult Unmarshaller
DescribeDBEngineVersionsResult Unmarshaller
Response Unmarshaller for CreateDBInstanceReadReplica operation
AmazonRDS exception
Constructs a new StorageQuotaExceededException with the specified error
message.
Describes the error encountered.
Container for the parameters to the RestoreDBInstanceToPointInTime operation.
Creates a new DB Instance from a point-in-time system snapshot. The target database is created from the source database restore point
with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
Sets the SourceDBInstanceIdentifier property
The value to set for the SourceDBInstanceIdentifier property
this instance
Sets the TargetDBInstanceIdentifier property
The value to set for the TargetDBInstanceIdentifier property
this instance
Sets the RestoreTime property
The value to set for the RestoreTime property
this instance
Sets the UseLatestRestorableTime property
The value to set for the UseLatestRestorableTime property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Sets the DBName property
The value to set for the DBName property
this instance
Sets the Engine property
The value to set for the Engine property
this instance
The identifier of the source DB Instance from which to restore. Constraints: - Must be the identifier of an existing database
instance
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end
with a hyphen or contain two consecutive hyphens
The name of the new database instance to be created. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The date and time from to restore from. Valid Values: Value must be a UTC time Constraints: - Must be after the latest restorable
time for the DB Instance
- Cannot be specified if UseLatestRestorableTime parameter is true
Example:
2009-09-07T23:45:00Z
Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time. Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.2xlarge |
db.m2.4xlarge Default: The same DBInstanceClass as the original DB Instance.
The port number on which the database accepts connections. Constraints: Value must be 1115-65535 Default: The same port as the
original DB Instance.
The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You
cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
Specifies if the DB Instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
License model information for the restored DB Instance. Default: Same as source. Valid values: license-included |
bring-your-own-license | general-public-license
The database name for the restored DB Instance. This parameter is not used for the MySQL engine.
The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Returns information about the ResetDBParameterGroupResult response and response metadata.
Gets and sets the ResetDBParameterGroupResult property.
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
Container for the parameters to the DescribeReservedDBInstancesOfferings operation.
Lists available reserved DB Instance offerings.
Sets the ReservedDBInstancesOfferingId property
The value to set for the ReservedDBInstancesOfferingId property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Duration property
The value to set for the Duration property
this instance
Sets the ProductDescription property
The value to set for the ProductDescription property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation
identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1
| 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the
response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to
MaxRecords.
Container for the parameters to the DescribeDBSnapshots operation.
Returns information about DBSnapshots. This API supports pagination.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the DBSnapshotIdentifier property
The value to set for the DBSnapshotIdentifier property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The unique identifier for the Amazon RDS DB snapshot. This value is stored as a lowercase string. Constraints: - Must contain from 1
to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two
consecutive hyphens
The DB Instance identifier. This parameter isn't case sensitive. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
AmazonRDS exception
Constructs a new AuthorizationQuotaExceededException with the specified error
message.
Describes the error encountered.
Implemenation for accessing AmazonRDS.
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up,
operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational
database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses
unique. Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code,
applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon
RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can
scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services,
there are no up-front investments, and you pay only for the resources you use.
Interface for accessing AmazonRDS.
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up,
operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational
database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses
unique. Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code,
applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon
RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can
scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services,
there are no up-front investments, and you pay only for the resources you use.
Returns information about provisioned RDS instances. This API supports pagination.
Container for the necessary parameters to execute the DescribeDBInstances service method on
AmazonRDS.
The response from the DescribeDBInstances service method, as returned by AmazonRDS.
Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events
specific to a particular DB Instance, database security group, database snapshot or database parameter group can be obtained by providing
the name as a parameter. By default, the past hour of events are returned.
Container for the necessary parameters to execute the DescribeEvents service method on
AmazonRDS.
The response from the DescribeEvents service method, as returned by AmazonRDS.
Returns the detailed parameter list for a particular DBParameterGroup.
Container for the necessary parameters to execute the DescribeDBParameters service method on
AmazonRDS.
The response from the DescribeDBParameters service method, as returned by AmazonRDS.
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the
DBSecurityGroup if the application using the database is running on EC2 instances. Second, IP ranges are available if the application
accessing your database is running on the Internet. Required parameters for this API are one of CIDR range or (EC2SecurityGroupName AND
EC2SecurityGroupOwnerId). NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS
DB Instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress
service method on AmazonRDS.
The response from the AuthorizeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of
the specified DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Container for the necessary parameters to execute the DescribeDBSecurityGroups service method
on AmazonRDS.
The response from the DescribeDBSecurityGroups service method, as returned by AmazonRDS.
Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the
following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to
take effect on the next DB instance restart or RebootDBInstance request.
Container for the necessary parameters to execute the ResetDBParameterGroup service method on
AmazonRDS.
The response from the ResetDBParameterGroup service method, as returned by AmazonRDS.
Creates a new DB Instance from a point-in-time system snapshot. The target database is created from the source database restore point
with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime
service method on AmazonRDS.
The response from the RestoreDBInstanceToPointInTime service method, as returned by AmazonRDS.
Returns a list of the available DB engines.
Container for the necessary parameters to execute the DescribeDBEngineVersions service method
on AmazonRDS.
The response from the DescribeDBEngineVersions service method, as returned by AmazonRDS.
Creates a new database parameter group.
Container for the necessary parameters to execute the CreateDBParameterGroup service method on
AmazonRDS.
The response from the CreateDBParameterGroup service method, as returned by AmazonRDS.
Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and
the new values in the request.
Container for the necessary parameters to execute the ModifyDBInstance service method on
AmazonRDS.
The response from the ModifyDBInstance service method, as returned by AmazonRDS.
Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up
to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database
except that the DB instance is created with the default DB security group.
Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
service method on AmazonRDS.
The response from the RestoreDBInstanceFromDBSnapshot service method, as returned by AmazonRDS.
Creates a new database security group. Database Security groups control access to a database instance.
Container for the necessary parameters to execute the CreateDBSecurityGroup service method on
AmazonRDS.
The response from the CreateDBSecurityGroup service method, as returned by AmazonRDS.
Deletes a database security group. NOTE:The specified database security group must not be associated with any DB
instances.
Container for the necessary parameters to execute the DeleteDBSecurityGroup service method on
AmazonRDS.
Returns a list of orderable DB Instance options for the specified engine.
Container for the necessary parameters to execute the
DescribeOrderableDBInstanceOptions service method on AmazonRDS.
The response from the DescribeOrderableDBInstanceOptions service method, as returned by AmazonRDS.
Lists available reserved DB Instance offerings.
Container for the necessary parameters to execute the
DescribeReservedDBInstancesOfferings service method on AmazonRDS.
The response from the DescribeReservedDBInstancesOfferings service method, as returned by AmazonRDS.
Creates a DB Instance that acts as a Read Replica of a source DB Instance. All Read Replica DB Instances are created
as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are
inherited from the source DB Instance, except as specified below. IMPORTANT: The source DB Instance must have backup
retention enabled.
Container for the necessary parameters to execute the CreateDBInstanceReadReplica service
method on AmazonRDS.
The response from the CreateDBInstanceReadReplica service method, as returned by AmazonRDS.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. Required parameters for this API
are one of CIDRIP or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).
Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress service
method on AmazonRDS.
The response from the RevokeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Creates a DBSnapshot. The source DBInstance must be in "available" state.
Container for the necessary parameters to execute the CreateDBSnapshot service method on
AmazonRDS.
The response from the CreateDBSnapshot service method, as returned by AmazonRDS.
Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with
ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS
instance during which the RDS instance status is set to rebooting. A DBInstance event is created when the reboot is completed.
Container for the necessary parameters to execute the RebootDBInstance service method on
AmazonRDS.
The response from the RebootDBInstance service method, as returned by AmazonRDS.
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions
of the specified DBParameterGroup.
Container for the necessary parameters to execute the DescribeDBParameterGroups service
method on AmazonRDS.
The response from the DescribeDBParameterGroups service method, as returned by AmazonRDS.
Creates a new DB instance.
Container for the necessary parameters to execute the CreateDBInstance service method on
AmazonRDS.
The response from the CreateDBInstance service method, as returned by AmazonRDS.
The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the
request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is
created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
Container for the necessary parameters to execute the DeleteDBInstance service method on
AmazonRDS.
The response from the DeleteDBInstance service method, as returned by AmazonRDS.
Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
NOTE: The specified database parameter group cannot be associated with any DB Instances.
Container for the necessary parameters to execute the DeleteDBParameterGroup service method on
AmazonRDS.
Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName,
ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Container for the necessary parameters to execute the ModifyDBParameterGroup service method on
AmazonRDS.
The response from the ModifyDBParameterGroup service method, as returned by AmazonRDS.
Returns information about DBSnapshots. This API supports pagination.
Container for the necessary parameters to execute the DescribeDBSnapshots service method on
AmazonRDS.
The response from the DescribeDBSnapshots service method, as returned by AmazonRDS.
Purchases a reserved DB Instance offering.
Container for the necessary parameters to execute the
PurchaseReservedDBInstancesOffering service method on AmazonRDS.
The response from the PurchaseReservedDBInstancesOffering service method, as returned by AmazonRDS.
Returns the default engine and system parameter information for the specified database engine.
Container for the necessary parameters to execute the DescribeEngineDefaultParameters
service method on AmazonRDS.
The response from the DescribeEngineDefaultParameters service method, as returned by AmazonRDS.
Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
Container for the necessary parameters to execute the DescribeReservedDBInstances service
method on AmazonRDS.
The response from the DescribeReservedDBInstances service method, as returned by AmazonRDS.
Deletes a DBSnapshot. NOTE:The DBSnapshot must be in the available state to be deleted.
Container for the necessary parameters to execute the DeleteDBSnapshot service method on
AmazonRDS.
The response from the DeleteDBSnapshot service method, as returned by AmazonRDS.
Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonRDSClient with AWS Access Key ID, AWS Secret Key and an
AmazonRDSClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonRDSClient Configuration Object
Returns information about provisioned RDS instances. This API supports pagination.
Container for the necessary parameters to execute the DescribeDBInstances service method on
AmazonRDS.
The response from the DescribeDBInstances service method, as returned by AmazonRDS.
Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events
specific to a particular DB Instance, database security group, database snapshot or database parameter group can be obtained by providing
the name as a parameter. By default, the past hour of events are returned.
Container for the necessary parameters to execute the DescribeEvents service method on
AmazonRDS.
The response from the DescribeEvents service method, as returned by AmazonRDS.
Returns the detailed parameter list for a particular DBParameterGroup.
Container for the necessary parameters to execute the DescribeDBParameters service method on
AmazonRDS.
The response from the DescribeDBParameters service method, as returned by AmazonRDS.
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the
DBSecurityGroup if the application using the database is running on EC2 instances. Second, IP ranges are available if the application
accessing your database is running on the Internet. Required parameters for this API are one of CIDR range or (EC2SecurityGroupName AND
EC2SecurityGroupOwnerId). NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS
DB Instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress
service method on AmazonRDS.
The response from the AuthorizeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of
the specified DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Container for the necessary parameters to execute the DescribeDBSecurityGroups service method
on AmazonRDS.
The response from the DescribeDBSecurityGroups service method, as returned by AmazonRDS.
Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the
following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to
take effect on the next DB instance restart or RebootDBInstance request.
Container for the necessary parameters to execute the ResetDBParameterGroup service method on
AmazonRDS.
The response from the ResetDBParameterGroup service method, as returned by AmazonRDS.
Creates a new DB Instance from a point-in-time system snapshot. The target database is created from the source database restore point
with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime
service method on AmazonRDS.
The response from the RestoreDBInstanceToPointInTime service method, as returned by AmazonRDS.
Returns a list of the available DB engines.
Container for the necessary parameters to execute the DescribeDBEngineVersions service method
on AmazonRDS.
The response from the DescribeDBEngineVersions service method, as returned by AmazonRDS.
Creates a new database parameter group.
Container for the necessary parameters to execute the CreateDBParameterGroup service method on
AmazonRDS.
The response from the CreateDBParameterGroup service method, as returned by AmazonRDS.
Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and
the new values in the request.
Container for the necessary parameters to execute the ModifyDBInstance service method on
AmazonRDS.
The response from the ModifyDBInstance service method, as returned by AmazonRDS.
Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up
to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database
except that the DB instance is created with the default DB security group.
Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
service method on AmazonRDS.
The response from the RestoreDBInstanceFromDBSnapshot service method, as returned by AmazonRDS.
Creates a new database security group. Database Security groups control access to a database instance.
Container for the necessary parameters to execute the CreateDBSecurityGroup service method on
AmazonRDS.
The response from the CreateDBSecurityGroup service method, as returned by AmazonRDS.
Deletes a database security group. NOTE:The specified database security group must not be associated with any DB
instances.
Container for the necessary parameters to execute the DeleteDBSecurityGroup service method on
AmazonRDS.
Returns a list of orderable DB Instance options for the specified engine.
Container for the necessary parameters to execute the
DescribeOrderableDBInstanceOptions service method on AmazonRDS.
The response from the DescribeOrderableDBInstanceOptions service method, as returned by AmazonRDS.
Lists available reserved DB Instance offerings.
Container for the necessary parameters to execute the
DescribeReservedDBInstancesOfferings service method on AmazonRDS.
The response from the DescribeReservedDBInstancesOfferings service method, as returned by AmazonRDS.
Creates a DB Instance that acts as a Read Replica of a source DB Instance. All Read Replica DB Instances are created
as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are
inherited from the source DB Instance, except as specified below. IMPORTANT: The source DB Instance must have backup
retention enabled.
Container for the necessary parameters to execute the CreateDBInstanceReadReplica service
method on AmazonRDS.
The response from the CreateDBInstanceReadReplica service method, as returned by AmazonRDS.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. Required parameters for this API
are one of CIDRIP or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).
Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress service
method on AmazonRDS.
The response from the RevokeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Creates a DBSnapshot. The source DBInstance must be in "available" state.
Container for the necessary parameters to execute the CreateDBSnapshot service method on
AmazonRDS.
The response from the CreateDBSnapshot service method, as returned by AmazonRDS.
Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with
ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS
instance during which the RDS instance status is set to rebooting. A DBInstance event is created when the reboot is completed.
Container for the necessary parameters to execute the RebootDBInstance service method on
AmazonRDS.
The response from the RebootDBInstance service method, as returned by AmazonRDS.
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions
of the specified DBParameterGroup.
Container for the necessary parameters to execute the DescribeDBParameterGroups service
method on AmazonRDS.
The response from the DescribeDBParameterGroups service method, as returned by AmazonRDS.
Creates a new DB instance.
Container for the necessary parameters to execute the CreateDBInstance service method on
AmazonRDS.
The response from the CreateDBInstance service method, as returned by AmazonRDS.
The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the
request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is
created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
Container for the necessary parameters to execute the DeleteDBInstance service method on
AmazonRDS.
The response from the DeleteDBInstance service method, as returned by AmazonRDS.
Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
NOTE: The specified database parameter group cannot be associated with any DB Instances.
Container for the necessary parameters to execute the DeleteDBParameterGroup service method on
AmazonRDS.
Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName,
ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Container for the necessary parameters to execute the ModifyDBParameterGroup service method on
AmazonRDS.
The response from the ModifyDBParameterGroup service method, as returned by AmazonRDS.
Returns information about DBSnapshots. This API supports pagination.
Container for the necessary parameters to execute the DescribeDBSnapshots service method on
AmazonRDS.
The response from the DescribeDBSnapshots service method, as returned by AmazonRDS.
Purchases a reserved DB Instance offering.
Container for the necessary parameters to execute the
PurchaseReservedDBInstancesOffering service method on AmazonRDS.
The response from the PurchaseReservedDBInstancesOffering service method, as returned by AmazonRDS.
Returns the default engine and system parameter information for the specified database engine.
Container for the necessary parameters to execute the DescribeEngineDefaultParameters
service method on AmazonRDS.
The response from the DescribeEngineDefaultParameters service method, as returned by AmazonRDS.
Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
Container for the necessary parameters to execute the DescribeReservedDBInstances service
method on AmazonRDS.
The response from the DescribeReservedDBInstances service method, as returned by AmazonRDS.
Deletes a DBSnapshot. NOTE:The DBSnapshot must be in the available state to be deleted.
Container for the necessary parameters to execute the DeleteDBSnapshot service method on
AmazonRDS.
The response from the DeleteDBSnapshot service method, as returned by AmazonRDS.
Output structure for the CancelJob operation.
Sets the Success property
The value to set for the Success property
this instance
Specifies whether (true) or not (false) AWS Import/Export updated your
job.
Container for the parameters to the UpdateLoginProfile operation.
Updates the login profile for the specified User. Use this API
to change the User's password.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Password property
The value to set for the Password property
this instance
Name of the User whose login profile you want to update.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The new password for the User name.
Constraints:
-
Length
1 - 128
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Response Unmarshaller for UploadSigningCertificate operation
Response Unmarshaller for UpdateAccessKey operation
Response Unmarshaller for GetGroup operation
Delete User Request Marshaller
Response Unmarshaller for CreateLoginProfile operation
Response Unmarshaller for AddUserToGroup operation
ServerCertificateMetadata contains information about a server
certificate without its certificate body, certificate chain, and
private key. This data type is used as a response element
in the action UploadServerCertificate and
ListServerCertificates.
Sets the Path property
The value to set for the Path property
this instance
Sets the ServerCertificateName property
The value to set for the ServerCertificateName property
this instance
Sets the ServerCertificateId property
The value to set for the ServerCertificateId property
this instance
Sets the Arn property
The value to set for the Arn property
this instance
Sets the UploadDate property
The value to set for the UploadDate property
this instance
Path to the server certificate. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
The name that identifies the server certificate.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The stable and unique string identifying the server certificate. For more information about IDs, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see Identifiers for IAM
Entities in Using AWS Identity and Access Management.
Constraints:
-
Length
20 - 2048
The date when the server certificate was uploaded.
Container for the parameters to the RemoveUserFromGroup operation.
Removes the specified User from the specified group.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the UserName property
The value to set for the UserName property
this instance
Name of the group to update.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the User to remove.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
AmazonIdentityManagementService exception
Constructs a new MalformedPolicyDocumentException with the specified error
message.
Describes the error encountered.
Returns information about the GetLoginProfileResult response and response metadata.
Gets and sets the GetLoginProfileResult property.
Contains the result of a successful invocation of the GetLoginProfile action.
Container for the parameters to the DeleteAccountAlias operation.
Deletes the specified AWS Account alias. For information about
using an AWS Account alias, see Using an Alias for Your AWS Account ID
in Using AWS Identity and Access Management .
Sets the AccountAlias property
The value to set for the AccountAlias property
this instance
Name of the account alias to delete.
Constraints:
-
Length
3 - 63
-
Pattern
^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$
Container for the parameters to the CreateAccessKey operation.
Creates a new AWS Secret Access Key and corresponding AWS Access
Key ID for the specified User. The default status for new keys is
Active . If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users. For
information about limits on the number of keys you can create, see
Limitations on IAM Entities in Using AWS Identity and Access
Management . IMPORTANT:To ensure the security
of your AWS Account, the Secret Access Key is accessible only during
key and User creation. You must save the key (for example, in a text
file) if you want to be able to access it again. If a secret key is
lost, you can delete the access keys for the associated User and then
create new keys.
Sets the UserName property
The value to set for the UserName property
this instance
The User name that the new key will belong to.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Returns information about the AddUserToGroup response metadata.
The AddUserToGroup operation has a void result type.
Response Unmarshaller for AddJobFlowSteps operation
Container for the parameters to the TerminateJobFlows operation.
TerminateJobFlows shuts a list of job flows down. When a job
flow is shut down, any step not yet completed is canceled and the EC2
instances on which the job flow is running are stopped. Any log files
not already saved are uploaded to Amazon S3 if a LogUri was specified
when the job flow was created.
Adds elements to the JobFlowIds collection
The values to add to the JobFlowIds collection
this instance
A list of job flows to be shutdown.
A key value pair.
Sets the Key property
The value to set for the Key property
this instance
Sets the Value property
The value to set for the Value property
this instance
The unique identifier of a key value pair.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The value part of the identified key.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Configuration of a bootstrap action.
Sets the Name property
The value to set for the Name property
this instance
Sets the ScriptBootstrapAction property
The value to set for the ScriptBootstrapAction property
this instance
The name of the bootstrap action.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The script run by the bootstrap action.
Returns information about the AddJobFlowSteps response metadata.
The AddJobFlowSteps operation has a void result type.
Response Unmarshaller for RegisterInstancesWithLoadBalancer operation
Response Unmarshaller for EnableAvailabilityZonesForLoadBalancer operation
The output for the DisableAvailabilityZonesForLoadBalancer action.
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
A list of updated Availability Zones for the LoadBalancer.
The output for the DeleteLoadBalancerListeners action.
Container for the parameters to the CreateAppCookieStickinessPolicy operation.
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be
associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy,
except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in
the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application
cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application
cookie is issued. NOTE: An application client must receive and send two cookies: the application-generated cookie and
the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.
Default constructor for a new CreateAppCookieStickinessPolicyRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new CreateAppCookieStickinessPolicyRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
Name of the application cookie used for stickiness.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the CookieName property
The value to set for the CookieName property
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
Name of the application cookie used for stickiness.
Returns information about the ConfigureHealthCheckResult response and response metadata.
Gets and sets the ConfigureHealthCheckResult property.
The output for the ConfigureHealthCheck action.
Configuration for accessing Elastic Load Balancing service
Default constructor
Gets the ServiceVersion property.
UpdateEnvironmentResult Unmarshaller
LoadBalancerDescription Unmarshaller
EnvironmentResourcesDescription Unmarshaller
Describe Events Request Marshaller
Delete Configuration Template Request Marshaller
Response Unmarshaller for DeleteApplication operation
Response Unmarshaller for CreateConfigurationTemplate operation
Response Unmarshaller for CreateApplication operation
Result message containing a description of the requested environment info.
Adds elements to the EnvironmentInfo collection
The values to add to the EnvironmentInfo collection
this instance
Adds elements to the EnvironmentInfo collection
The values to add to the EnvironmentInfo collection
this instance
The EnvironmentInfoDescription of the environment.
Container for the parameters to the DescribeConfigurationOptions operation.
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution
stack defines. The description includes the values the options, their default values, and an indication of the required action on a running
environment if an option value is changed.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Adds elements to the Options collection
The values to add to the Options collection
this instance
Adds elements to the Options collection
The values to add to the Options collection
this instance
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration
options associated with either the configuration template or environment.
Constraints:
-
Length
1 - 100
The name of the configuration template whose configuration options you want to describe.
Constraints:
-
Length
1 - 100
The name of the environment whose configuration options you want to describe.
Constraints:
-
Length
4 - 23
The name of the solution stack whose configuration options you want to describe.
Constraints:
-
Length
0 - 100
If specified, restricts the descriptions to only the specified options.
VPN Connection
Sets the VpnConnectionId property
The ID of the VPN connection
this instance
Checks if VpnConnectionId property is set
true if VpnConnectionId property is set
Sets the VpnConnectionState property
The current state of the VPN connection
(pending, available, deleting, deleted)
this instance
Checks if VpnConnectionState property is set
true if VpnConnectionState property is set
Sets the CustomerGatewayConfiguration property
Configuration information for the VPN
connection's customer gateway (in the
native XML format).
this instance
Checks if CustomerGatewayConfiguration property is set
true if CustomerGatewayConfiguration property is set
Sets the Type property
The type of VPN connection (ipsec.1).
this instance
Checks if Type property is set
true if Type property is set
Sets the CustomerGatewayId property
ID of the customer gateway at your end of the
VPN connection
this instance
Checks if CustomerGatewayId property is set
true if CustomerGatewayId property is set
Sets the VpnGatewayId property
ID of the VPN gateway at the VPC end of the VPN
connection
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Sets the Tag property
Tag property
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the VpnConnectionId property.
The ID of the VPN connection
Gets and sets the VpnConnectionState property.
The current state of the VPN connection
(pending, available, deleting, deleted)
Gets and sets the CustomerGatewayConfiguration property.
Configuration information for the VPN
connection's customer gateway (in the
native XML format).
Gets and sets the Type property.
The type of VPN connection (ipsec.1).
Gets and sets the CustomerGatewayId property.
ID of the customer gateway at your end of the
VPN connection
Gets and sets the VpnGatewayId property.
ID of the VPN gateway at the VPC end of the VPN
connection
Gets and sets the Tag property.
Terminate Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if TerminateInstancesResult property is set
true if TerminateInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the TerminateInstancesResult property.
Terminate Instances Result
S3 Storage
Sets the Bucket property
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.
this instance
Checks if Bucket property is set
true if Bucket property is set
Sets the Prefix property
Specifies the beginning of the file name of the AMI.
this instance
Checks if Prefix property is set
true if Prefix property is set
Sets the AWSAccessKeyId property
The Access Key ID of the owner of the Amazon S3 bucket.
this instance
Checks if AWSAccessKeyId property is set
true if AWSAccessKeyId property is set
Sets the UploadPolicy property
A Base64-encoded Amazon S3 upload policy that
gives Amazon EC2 permission to upload items into
Amazon S3 on the user's behalf
this instance
Checks if UploadPolicy property is set
true if UploadPolicy property is set
Sets the UploadPolicySignature property
The signature of the Base64 encoded JSON
document.
this instance
Checks if UploadPolicySignature property is set
true if UploadPolicySignature property is set
Gets and sets the Bucket property.
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.
Gets and sets the Prefix property.
Specifies the beginning of the file name of the AMI.
Gets and sets the AWSAccessKeyId property.
The Access Key ID of the owner of the Amazon S3 bucket.
Gets and sets the UploadPolicy property.
A Base64-encoded Amazon S3 upload policy that
gives Amazon EC2 permission to upload items into
Amazon S3 on the user's behalf
Gets and sets the UploadPolicySignature property.
The signature of the Base64 encoded JSON
document.
The Response for the
RevokeSecurityGroupEgress operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups.
For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual
Private Cloud User Guide.
The action removes one or more egress rules from a VPC security group. The values that you specify in
the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be
revoked.
Each rule consists of the protocol, and the CIDR range or destination security group. For the TCP and
UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you
must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a
small delay might occur.
Sets the GroupId property
ID of the VPC security group to modify.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the IpPermissions property
Set of IP permissions associated with the
security group.
this instance
Checks if IpPermissions property is set
true if IpPermissions property is set
Gets and sets the GroupId property.
ID of the VPC security group to modify.
Gets and sets the IpPermissions property.
Set of IP permissions associated with the
security group.
Information returned by a ResetInstanceAttribute
request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Release Address Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Represents a placement group into which multiple Amazon EC2
instances can be launched. A placement group ensures that
Amazon EC2 instances are physically located close enough to
support HPC features, such as higher IO network connections between
instances in the group.
Sets the GroupName property
The name of the PlacementGroup.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the Strategy property
The strategy to use when allocating Amazon EC2
instances for the
PlacementGroup.
this instance
Checks if Strategy property is set
true if Strategy property is set
Sets the State property
The state of this PlacementGroup.
this instance
Checks if State property is set
true if State property is set
Gets and sets the GroupName property.
The name of the PlacementGroup.
Gets and sets the Strategy property.
The strategy to use when allocating Amazon EC2
instances for the
PlacementGroup.
Gets and sets the State property.
The state of this PlacementGroup.
Specifies additional launch instance information.
Sets the ImageId property
The AMI ID.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the KeyName property
The name of the key pair.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the SecurityGroup property
The Security Groups to associate the launched
instance with.
this instance
Checks if SecurityGroup property is set
true if SecurityGroup property is set
Sets the SecurityGroupId property
IDs of the security group.
this instance
Checks if SecurityGroupId property is set
true if SecurityGroupId property is set
Sets the UserData property
MIME, Base64-encoded user data.
this instance
Checks if UserData property is set
true if UserData property is set
Sets the AddressingType property
Deprecated.
this instance
Checks if AddressingType property is set
true if AddressingType property is set
Sets the InstanceType property
Specifies the instance type. Valid values are:
m1.small | m1.large | m1.xlarge |
c1.medium | c1.xlarge |
m2.2xlarge | m2.4xlarge.
Default: m1.small
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the Placement property
Specifies the placement constraints.
this instance
Checks if Placement property is set
true if Placement property is set
Sets the KernelId property
The ID of the kernel to select.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
The ID of the RAM disk to select. Some kernels
require additional drivers at launch. Check the kernel
requirements for information on whether you need to
specify a RAM
disk.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the BlockDeviceMapping property
Specifies how block devices are exposed to the
instance. Each mapping is made up of a virtualName
and a deviceName.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Sets the Monitoring property
Specifies whether to enable monitoring for the Spot Instance.
this instance
Checks if Monitoring property is set
true if Monitoring property is set
Sets the SubnetId property
Specifies the Amazon VPC subnet ID within which to
launch the instance(s) for Amazon Virtual Private Cloud.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Gets and sets the ImageId property.
The AMI ID.
Gets and sets the KeyName property.
The name of the key pair.
Gets and sets the SecurityGroup property.
The Security Groups to associate the launched
instance with.
Gets and sets the SecurityGroupId property.
IDs of the security group.
Gets and sets the UserData property.
MIME, Base64-encoded user data.
Gets and sets the AddressingType property.
Deprecated.
Gets and sets the InstanceType property.
Specifies the instance type. Valid values are:
m1.small | m1.large | m1.xlarge |
c1.medium | c1.xlarge |
m2.2xlarge | m2.4xlarge.
Default: m1.small
Gets and sets the Placement property.
Specifies the placement constraints.
Gets and sets the KernelId property.
The ID of the kernel to select.
Gets and sets the RamdiskId property.
The ID of the RAM disk to select. Some kernels
require additional drivers at launch. Check the kernel
requirements for information on whether you need to
specify a RAM
disk.
Gets and sets the BlockDeviceMapping property.
Specifies how block devices are exposed to the
instance. Each mapping is made up of a virtualName
and a deviceName.
Gets and sets the Monitoring property.
Specifies whether to enable monitoring for the Spot Instance.
Gets and sets the SubnetId property.
Specifies the Amazon VPC subnet ID within which to
launch the instance(s) for Amazon Virtual Private Cloud.
Information about the instance EBS block device.
Sets the VolumeId property
The ID of the Amazon EBS volume.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the DeleteOnTermination property
Specifies whether the Amazon EBS volume is
deleted on instance termination.
this instance
Checks if DeleteOnTermination property is set
true if DeleteOnTermination property is set
Gets and sets the VolumeId property.
The ID of the Amazon EBS volume.
Gets and sets the DeleteOnTermination property.
Specifies whether the Amazon EBS volume is
deleted on instance termination.
Retrieves console output for the specified
instance.
Instance console output is buffered and posted shortly
after instance boot,
reboot, and termination. Amazon EC2 preserves
the most recent 64 KB output which
will be available for at least
one hour after the most recent post
Sets the InstanceId property
ID of the instance for which you want console
output.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
ID of the instance for which you want console
output.
Details about the image.
Sets the Image property
Details about the format of the image.
this instance
Checks if Image property is set
true if Image property is set
Sets the Description property
Optional description of the disk image.
this instance
Checks if Description property is set
true if Description property is set
Sets the Volume property
Details about the size of the image.
this instance
Checks if Volume property is set
true if Volume property is set
Gets and sets the Image property.
Details about the format of the image.
Gets and sets the Description property.
Optional description of the disk image.
Gets and sets the Volume property.
Details about the size of the image.
DHCP Configuration
Sets the Key property
The name of a DHCP option.
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
A value for the DHCP option.
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the Key property.
The name of a DHCP option.
Gets and sets the Value property.
A value for the DHCP option.
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. For more information about your
VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
For more information about Amazon Virtual Private Cloud and Internet gateways, go to the Amazon Virtual
Private Cloud User Guide.
Sets the InternetGatewayId property
The ID of the Internet gateway to attach.
this instance
Checks if InternetGatewayId property is set
true if InternetGatewayId property is set
Sets the VpcId property
The ID of the VPC.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the InternetGatewayId property.
The ID of the Internet gateway to attach.
Gets and sets the VpcId property.
The ID of the VPC.
The list of cancelled Spot Instance requests.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSpotPriceHistoryResult property is set
true if DescribeSpotPriceHistoryResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSpotPriceHistoryResult property.
The Result containing the Spot Price history data.
Deletes a subnet from a VPC. You must terminate all running instances in
the subnet before deleting it, otherwise Amazon VPC returns an error.
AWS might delete any subnet if you leave it inactive for an extended
period of time (inactive means that there are no running
Amazon EC2 instances in the subnet).
Sets the SubnetId property
The ID of the subnet you want to delete.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Gets and sets the SubnetId property.
The ID of the subnet you want to delete.
Delete Snapshot Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Vpn Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateVpnGatewayResult property is set
true if CreateVpnGatewayResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateVpnGatewayResult property.
Create Vpn Gateway Result
Creates a VPC with the CIDR block you specify.
The smallest VPC you can create uses a /28 netmask (16 IP
addresses), and the largest uses a /18 netmask (16,384 IP addresses).
To help you decide how big to make your VPC, go to the
topic about creating VPCs in the Amazon Virtual Private Cloud
Developer Guide.
By default, each instance you launch in the VPC has the default DHCP
options (the standard EC2 host name, no domain name, no DNS server, no NTP
server, and no NetBIOS server or node type).
AWS might delete any VPC that you create with this operation
if you leave it inactive for an extended period of time (inactive
means that there are no running Amazon EC2 instances in the VPC).
Sets the CidrBlock property
A valid CIDR block.
Constraints: Must contain the slash followed by one or two digits (e.g., /28)
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Checks if InstanceTenancy property is set
true if InstanceTenancy property is set
Sets the InstanceTenancy property
Valid Values: default | dedicated
The allowed tenancy of instances launched into the VPC.
this instance
Gets and sets the CidrBlock property.
A valid CIDR block.
Constraints: Must contain the slash followed by one or two digits (e.g., /28)
Gets and sets the InstanceTenancy property.
The allowed tenancy of instances launched into the VPC. A value of default means instances
can be launched with any tenancy; a value of dedicated means instances must be launched
with tenancy as dedicated.
Valid Values: default | dedicated
The Response for the
CreateRoute operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
The Response from the CancelSpotInstanceRequests
operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CancelSpotInstanceRequestsResult property is set
true if CancelSpotInstanceRequestsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CancelSpotInstanceRequestsResult property.
The Cancel Spot Instance Requests Result.
Volume Attachment
Sets the VolumeId property
The ID of the volume.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Device property
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
this instance
Checks if Device property is set
true if Device property is set
Sets the Status property
Attachment state. Valid Values: attaching |
attached | detaching | detached
this instance
Checks if Status property is set
true if Status property is set
Sets the AttachTime property
Time stamp when the association was created.
this instance
Checks if AttachTime property is set
true if AttachTime property is set
Sets the DeleteOnTermination property
Determines whether the EBS block device is
deleted on instance termination.
this instance
Checks if DeleteOnTermination property is set
true if DeleteOnTermination property is set
Gets and sets the VolumeId property.
The ID of the volume.
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the Device property.
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Gets and sets the Status property.
Attachment state. Valid Values: attaching |
attached | detaching | detached
Gets and sets the AttachTime property.
Time stamp when the association was created.
Gets and sets the DeleteOnTermination property.
Determines whether the EBS block device is
deleted on instance termination.
The Response for the
AssociateRouteTable operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if AssociateRouteTableResult property is set
true if AssociateRouteTableResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the AssociateRouteTableResult property.
AssociateRouteTable Result
Put Metric Alarm Request Marshaller
Response Unmarshaller for ListMetrics operation
Returns information about the GetMetricStatisticsResult response and response metadata.
Gets and sets the GetMetricStatisticsResult property.
The output for the GetMetricStatistics action.
Returns information about the DescribeAlarmsResult response and response metadata.
Gets and sets the DescribeAlarmsResult property.
The output for the DescribeAlarms action.
The GetInvalidationResponse contains the details of a particular invalidation
and any headers returned by CloudFront.
Gets and Sets the Status property. Valid Values are InProgress and Completed
Gets and Sets the Id property which is the invalidation id
Gets and Sets the CreateTime property which is the date and time the invalidation request was first made.
Gets and Sets the InvalidationBatch property.
The GetDistributionConfigRequest contains the parameters used for the GetDistributionConfig operation.
Required Parameters: Id
Sets the Id property of this request to the value passed in.
The distribution's id
The request with the Id property set
Gets and sets the Id property for the Distribution
The DeleteOriginAccessIdentityResponse contains any headers returned by CloudFront.
A CloudFrontOriginAccessIdentity describes the information about a CloudFront Origin
Access Identity. It is used as a response element when Creating a new CloudFront Origin Access
Identity and when an Origin Access Identity's details are retrieved.
An origin access identity consists of the following items:
- Id
- S3 Canonical User Id
- The Configuration for the Origin Access Identity
For more information, please visit:
Checks if Id property is set.
true if Id property is set.
Checks if S3CanonicalUserId property is set.
true if S3CanonicalUserId property is set.
Checks if OriginAccessIdentityConfig property is set
true if OriginAccessIdentityConfig property is set
Creates an XML representation of this CloudFront
Origin Access Identity.
XML representation of the Origin Access Identity
Checks if the ETag property is set.
true if ETag property is set.
Gets and sets the Id property. This is the Id returned by CloudFront
when the distribution is created and is unique to the Distribution.
Gets and sets the Status property.
The current status of the Distribution can either be Deployed or In Progres
Gets and sets the current Origin Access Identity Configuration.
Gets and sets the ETag property of this
Origin Access Identity's Information.
The CloudFrontOriginAccessIdentityConfig complex type describes an origin access identity's configuration information.
An origin access identity configuration objects consists of the following items:
- Caller Reference
- Comment
For more information, please visit:
Creates an XML representation of the CloudFront
distribution configuration. The resulting XML
can be sent to CloudFront when creating or updating
a distribution.
XML representation of the distribution's configuration
Sets the Comment property.
Comment property
this instance
Checks if Comment property is set.
true if Comment property is set.
Sets the CallerReference property
CallerReference property
this instance
Checks if CallerReference property is set
true if CallerReference property is set
Checks if the ETag property is set.
true if ETag property is set.
Gets and sets the Comment property.
Any comments you want to include about the distribution.
The maximum length of the comment is 128 characters
Gets and sets the CallerReference property.
A unique number that ensures the request can't be replayed.
If the CallerReference is new (no matter the content of the
CloudFrontOriginAccessIdentityConfig object), a new distribution
is created. The default value set by the AWS SDK for NET is the
UtcNow timestamp.
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.
Gets and sets the ETag property of this
Origin Access Identity Configuration.
The ETag is the current version of the
configuration.
ValidateTemplateResult Unmarshaller
Get Template Request Marshaller
Response Unmarshaller for DescribeStackResource operation
Configuration for accessing AWS CloudFormation service
Default constructor
Gets the ServiceVersion property.
Response Unmarshaller for SetInstanceHealth operation
Put Scaling Policy Request Marshaller
Response Unmarshaller for PutNotificationConfiguration operation
MetricCollectionType Unmarshaller
Enable Metrics Collection Request Marshaller
Describe Scheduled Actions Request Marshaller
Response Unmarshaller for DescribePolicies operation
DescribeNotificationConfigurationsResult Unmarshaller
Describe Launch Configurations Request Marshaller
Response Unmarshaller for DeletePolicy operation
Container for the parameters to the TerminateInstanceInAutoScalingGroup operation.
Terminates the specified instance. Optionally, the desired group size can be adjusted. NOTE: This call simply
registers a termination request. The termination of the instance cannot happen immediately.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Sets the ShouldDecrementDesiredCapacity property
The value to set for the ShouldDecrementDesiredCapacity property
this instance
The ID of the EC2 instance to be terminated.
Constraints:
-
Length
1 - 16
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies whether (true) or not (false) terminating this instance should also decrement the size of the
AutoScalingGroup.
The EnabledMetric data type.
Sets the Metric property
The value to set for the Metric property
this instance
Sets the Granularity property
The value to set for the Granularity property
this instance
The name of the enabled metric.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The granularity of the enabled metric.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The PoliciesType data type.
Adds elements to the ScalingPolicies collection
The values to add to the ScalingPolicies collection
this instance
Adds elements to the ScalingPolicies collection
The values to add to the ScalingPolicies collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of scaling policies.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns information about the DescribeAutoScalingGroupsResult response and response metadata.
Gets and sets the DescribeAutoScalingGroupsResult property.
The AutoScalingGroupsType data type.
Returns information about the DeleteScheduledAction response metadata.
The DeleteScheduledAction operation has a void result type.
Returns information about the DeleteNotificationConfiguration response metadata.
The DeleteNotificationConfiguration operation has a void result type.
Returns information about the DeleteAutoScalingGroup response metadata.
The DeleteAutoScalingGroup operation has a void result type.
Returns information about the CreateAutoScalingGroup response metadata.
The CreateAutoScalingGroup operation has a void result type.
This class defines utilities and constants that can be used by
all the client libraries of the SDK.
The Set of accepted and valid Url characters.
Characters outside of this set will be encoded
The string representing Url Encoded Content in HTTP requests
The GMT Date Format string. Used when parsing date objects
The ISO8601Date Format string. Used when parsing date objects
The ISO8601Date Format string. Used when parsing date objects
The RFC822Date Format string. Used when parsing date objects
Convert Dictionary of paremeters to Url encoded query string
This method is used preserve the stacktrace used from clients that support async calls. This
make sure that exceptions thrown during EndXXX methods has the orignal stacktrace that happen
in the background thread.
Returns a new string created by joining each of the strings in the
specified list together, with a comma between them.
The list of strings to join into a single, comma delimited
string list.
A new string created by joining each of the strings in the
specified list together, with a comma between strings.
Gets the ISO8601 formatted timestamp that is minutesFromNow
in the future.
The number of minutes from the current instant
for which the timestamp is needed.
The ISO8601 formatted future timestamp.
Gets the RFC822 formatted timestamp that is minutesFromNow
in the future.
The number of minutes from the current instant
for which the timestamp is needed.
The ISO8601 formatted future timestamp.
Computes RFC 2104-compliant HMAC signature
The data to be signed
The secret signing key
The algorithm to sign the data with
A string representing the HMAC signature
Computes RFC 2104-compliant HMAC signature
The data to be signed
The secret signing key
The algorithm to sign the data with
A string representing the HMAC signature
URL encodes a string. If the path property is specified,
the accepted path characters {/+:} are not encoded.
The string to encode
Whether the string is a URL path or not
The AWS SDK User Agent
Formats the current date as a GMT timestamp
A GMT formatted string representation
of the current date and time
Formats the current date as ISO 8601 timestamp
An ISO 8601 formatted string representation
of the current date and time
Formats the current date as ISO 8601 timestamp
An ISO 8601 formatted string representation
of the current date and time
Deletes a topic and all its subscriptions.
Deleting a topic might
prevent some messages previously sent to the topic from being delivered to
subscribers. This operation is idempotent, so deleting a topic that does not
exist will not result in an error.
Sets the TopicArn property
The Amazon Reference Name (ARN) of the topic the client wants to delete.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Gets and sets the TopicArn property.
The Amazon Reference Name (ARN) of the topic the client wants to delete.
Amazon Simple Notification Service
Confirm Subscription
Confirm Subscription request
Confirm Subscription Response from the service
The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe action. If the
token is valid, the action creates a new subscription and returns its
Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".
Get Topic Attributes
Get Topic Attributes request
Get Topic Attributes Response from the service
The GetTopicAttribtues action returns all of the properties of a topic customers have created. Topic
properties returned might differ based on the authorization of the user.
Subscribe
Subscribe request
Subscribe Response from the service
The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are
valid for twenty-four hours.
Set Topic Attributes
Set Topic Attributes request
Set Topic Attributes Response from the service
The SetTopicAttributes action allows a topic owner to set an attribute of the topic to a new value.
Delete Topic
Delete Topic request
Delete Topic Response from the service
The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might
prevent some messages previously sent to the topic from being delivered to
subscribers. This action is idempotent, so deleting a topic that does not
exist will not result in an error.
Remove Permission
Remove Permission request
Remove Permission Response from the service
The RemovePermission action removes a statement from a topic's access control policy.
List Subscriptions
List Subscriptions request
List Subscriptions Response from the service
The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a
new ListSubscriptions call to get further results.
Add Permission
Add Permission request
Add Permission Response from the service
The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Create Topic
Create Topic request
Create Topic Response from the service
The CreateTopic action creates a topic to which notifications can be published. Users can create
at most 25 topics. This action is idempotent, so if the requester
already owns a topic with the specified name, that topic's ARN will be
returned without creating a new topic.
List Topics
List Topics request
List Topics Response from the service
The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics. If
there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get
further results.
Unsubscribe
Unsubscribe request
Unsubscribe Response from the service
The Unsubscribe action deletes a subscription. If the subscription requires authentication for
deletion, only the owner of the subscription or the its topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester is not
the subscription owner, a final cancellation message is delivered to the
endpoint, so that the endpoint owner can easily resubscribe to the topic if
the Unsubscribe request was unintended.
List Subscriptions By Topic
List Subscriptions By Topic request
List Subscriptions By Topic Response from the service
The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns
a limited list of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
Publish
Publish request
Publish Response from the service
The Publish action sends a message to all of a topic's subscribed endpoints. When a
messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it
to the topic's subscribers shortly. The format of the outgoing message to each
subscribed endpoint depends on the notification protocol selected.
Send Email Request Marshaller
Lists all domains associated with the account. It returns domain names up to the limit set by MaxNumberOfDomains.
A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times
with the NextToken returns up to MaxNumberOfDomains more domain names each time.
Sets the DomainName property
Domain name that matches the expression.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the NextToken property
An opaque token indicating that there are more than MaxNumberOfDomains domains still available.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the DomainName property.
Domain name that matches the expression.
Gets and sets the NextToken property.
An opaque token indicating that there are more than MaxNumberOfDomains domains still available.
Deletes a domain. Any items (and their attributes) in the domain are deleted, as well. The
operation might take 10 or more seconds to complete. Running DeleteDomain on a domain that
does not exist or running the function multiple times using the same domain name will not result in an error response.
Sets the DomainName property
The name of the domain to delete.
this instance
Checks if DomainName property is set
true if DomainName property is set
Gets and sets the DomainName property.
The name of the domain to delete.
Represents an Owner of an S3 Bucket.
Sets the Id property.
Id property
this instance
Sets the DisplayName property.
DisplayName property
this instance
Gets and sets the Id property.
Gets and sets the DisplayName property.
IComparable class that is used when sorting a lit of grants.
Compares the string representation of the grants
Represents a grant for an bucket/object ACL. A grant contains
a S3Grantee and a S3Permission for that S3Grantee.
For more information on Grants/ACLs refer:
Creates a string representation of a Grant.
The string representation of the Grant.
Sets the S3Grantee property.
S3Grantee property
this instance
Checks if S3Grantee property is set.
true if S3Grantee property is set.
Sets the S3Permission property.
S3Permission property
this instance
Checks if S3Permission property is set.
true if S3Permission property is set.
Gets and sets the Grantee property.
Gets and sets the Permission property.
This class is used to wrap a stream for a particular segment of a stream. It
makes that segment look like you are reading from beginning to end of the stream.
The ListMultipartUploadsRequest contains the parameters used for the ListMultipartUploads method.
Required Parameters: BucketName
Sets the BucketName property for this request.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the MaxUploads property for this request.
The value that MaxUploads is set to
the request with the MaxUploads set
Checks if MaxUploads property is set.
true if MaxUploads property is set.
Sets the KeyMarker property for this request.
The value that KeyMarker is set to
the request with the KeyMarker set
Checks if KeyMarker property is set.
true if KeyMarker property is set.
Sets the UploadIdMarker property for this request.
The value that UploadIdMarker is set to
the request with the UploadIdMarker set
Checks if UploadIdMarker property is set.
true if UploadIdMarker property is set.
Sets the Prefix property for this request.
All keys matched will have this prefix.
The value that Prefix is set to
this instance
Checks if Prefix property is set
true if Prefix property is set
Sets the Delimiter property for this request.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
the value that Delimiter is set to.
this instance
Checks if Delimiter property is set
true if Delimiter property is set
Gets and sets the BucketName property.
Gets and sets the MaxUploads property.
Sets the maximum number of multipart uploads to return in the response
body
Gets and sets the KeyMarker property.
Together with UploadIdMarker, specifies the multipart upload after
which listing should begin.
If UploadIdMarker is not specified, only the keys lexicographically
greater than the specified key-marker will be included in the list.
If UploadIdMarker is specified, any multipart uploads for a key
equal to the key-marker may also be included, provided those multipart
uploads have upload IDs lexicographically greater than the specified
UploadIdMarker.
Gets and sets the UploadIdMarker property.
Together with KeyMarker, specifies the multipart upload after which
listing should begin. If KeyMarker is not specified, the
UploadIdMarker parameter is ignored. Otherwise, any multipart
uploads for a key equal to the KeyMarker may be included in the list
only if they have an upload ID lexicographically greater than the specified
Gets and sets the Prefix property.
All keys matched will have this prefix.
Gets and sets the Delimiter property.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
Implements the Dispose pattern for the AmazonS3Client
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The S3 Configuration Object
Constructs an AmazonS3Client with AWS Access Key ID, AWS Secret Key and an
Amazon S3 Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The S3 Configuration Object
The GetPreSignedURL operations creates a signed http request.
Query string authentication is useful for giving HTTP or browser
access to resources that would normally require authentication.
When using query string authentication, you create a query,
specify an expiration time for the query, sign it with your
signature, place the data in an HTTP request, and distribute
the request to a user or embed the request in a web page.
A PreSigned URL can be generated for GET, PUT and HEAD
operations on your bucket, keys, and versions.
The GetPreSignedUrlRequest that defines the
parameters of the operation.
A string that is the signed http request.
The ListBuckets operation returns a list of all of the buckets
owned by the authenticated sender of the request.
Returns a ListBucketsResponse with the response from S3.
Initiates the asynchronous execution of the ListBuckets operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListBuckets.
Initiates the asynchronous execution of the ListBuckets operation.
The ListBucketsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListBuckets.
Finishes the asynchronous execution of the ListBuckets operation.
The IAsyncResult returned by the call to BeginListBuckets.
Returns a ListBucketsResponse from S3.
The ListBuckets operation returns a list of all of the buckets
owned by the authenticated sender of the request.
The ListBucketsRequest that defines the parameters
of this operation
Returns a ListBucketsResponse with the response from S3.
Initiates the asynchronous execution of the GetBucketLocation operation.
The GetBucketLocationRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketLocation.
Finishes the asynchronous execution of the GetBucketLocation operation.
The IAsyncResult returned by the call to BeginGetBucketLocation.
Returns a GetBucketLocationResponse from S3.
The GetBucketLocation operation takes in a bucket's name and lists the location
of the bucket. This information can be used to determine the bucket's geographical
location.
To determine the location of a bucket, you must be the bucket owner.
The GetBucketLocationRequest that defines the parameters of the operation.
Returns a GetBucketLocationResponse from S3.
Initiates the asynchronous execution of the GetBucketLogging operation.
The GetBucketLoggingRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketLogging.
Finishes the asynchronous execution of the GetBucketLogging operation.
The IAsyncResult returned by the call to BeginGetBucketLogging.
Returns a GetBucketLoggingResponse from S3.
The GetBucketLogging operating gets the logging status for the bucket specified.
For more information about S3Bucket Logging
see
The GetBucketLoggingRequest that defines
the parameters of the operation.
Returns a GetBucketLoggingResponse from S3.
Initiates the asynchronous execution of the EnableBucketLogging operation.
The EnableBucketLoggingRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndEnableBucketLogging.
Finishes the asynchronous execution of the EnableBucketLogging operation.
The IAsyncResult returned by the call to BeginEnableBucketLogging.
Returns a EnableBucketLoggingResponse from S3.
The EnableBucketLogging operation will turn on bucket logging for the bucket
specified in the request.
An Amazon S3 bucket can be configured to create access log records for the
requests made against it. An access log record contains details about the
request such as the request type, the resource with which the request worked,
and the time and date that the request was processed. Server access logs are
useful for many applications, because they give bucket owners insight into
the nature of requests made by clients not under their control.
The EnableBucketLoggingRequest that defines the parameters of
the operation.
Returns a EnableBucketLoggingResponse from S3.
Changes to the logging status for a bucket are visible in the configuration API immediately,
but they take time to actually affect the delivery of log files. For example, if you enable
logging for a bucket, some requests made in the following hour might be logged, while others
might not. Or, if you change the target bucket for logging from bucket A to bucket B, some
logs for the next hour might continue to be delivered to bucket A, while others might be delivered
to the new target bucket B. In all cases, the new settings will eventually take effect without any
further action on your part.
Initiates the asynchronous execution of the DisableBucketLogging operation.
The DisableBucketLoggingRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDisableBucketLogging.
Finishes the asynchronous execution of the DisableBucketLogging operation.
The IAsyncResult returned by the call to BeginDisableBucketLogging.
Returns a DisableBucketLoggingResponse from S3.
The DisableBucketLogging will turn off bucket logging for the bucket specified
in the request.
An Amazon S3 bucket can be configured to create access log records for the
requests made against it. An access log record contains details about the
request such as the request type, the resource with which the request worked,
and the time and date that the request was processed. Server access logs are
useful for many applications, because they give bucket owners insight into
the nature of requests made by clients not under their control.
The DisableBucketLoggingRequest that defines the parameters of the operation.
Returns a DisableBucketLoggingResponse from S3.
Initiates the asynchronous execution of the GetBucketVersioning operation.
The GetBucketVersioningRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketVersioning.
Finishes the asynchronous execution of the GetBucketVersioning operation.
The IAsyncResult returned by the call to BeginGetBucketVersioning.
Returns a GetBucketVersioningResponse from S3.
The GetBucketVersioning operation takes in a bucket's name and get the versioning
status of the bucket.
The GetBucketVersioningRequest that defines the parameters of the operation.
Returns a GetBucketVersioningResponse from S3.
Initiates the asynchronous execution of the SetBucketVersioning operation.
The SetBucketVersioningRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSetBucketVersioning.
Finishes the asynchronous execution of the SetBucketVersioning operation.
The IAsyncResult returned by the call to BeginSetBucketVersioning.
Returns a SetBucketVersioningResponse from S3.
The SetBucketVersioning operation takes in a bucket's name and the versioning
status you want to set on the bucket.
Valid values for the Versioning Status are Enabled and Suspended.
Once Versioning has been "Enabled" on a bucket, it can be "Suspended"
but cannot be switched "Off".
The SetBucketVersioningRequest that defines the parameters of the operation.
If SetBucketVersioningRequest.VersioningStatus has the value S3BucketVersioningStatus.Off
Returns a SetBucketVersioningResponse from S3.
Initiates the asynchronous execution of the GetBucketPolicy operation.
The GetBucketPolicyRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketPolicy.
Finishes the asynchronous execution of the GetBucketPolicy operation.
The IAsyncResult returned by the call to BeginGetBucketPolicy.
Returns a GetBucketPolicyResponse from S3.
Retrieves the policy for the specified bucket. Only the owner of the
bucket can retrieve the policy. If no policy has been set for the bucket,
then an error will be thrown.
Bucket policies provide access control management at the bucket level for
both the bucket resource and contained object resources. Only one policy
can be specified per-bucket.
For more information on forming bucket polices,
refer:
The GetBucketPolicyRequest that defines the parameters of the operation.
Returns a GetBucketPolicyResponse from S3.
Initiates the asynchronous execution of the PutBucketPolicy operation.
The PutBucketPolicyRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutBucketPolicy.
Finishes the asynchronous execution of the PutBucketPolicy operation.
The IAsyncResult returned by the call to BeginPutBucketPolicy.
Returns a PutBucketPolicyResponse from S3.
Sets the policy associated with the specified bucket. Only the owner of
the bucket can set a bucket policy. If a policy already exists for the
specified bucket, the new policy will replace the existing policy.
Bucket policies provide access control management at the bucket level for
both the bucket resource and contained object resources. Only one policy
may be specified per-bucket.
For more information on forming bucket polices,
refer:
The PutBucketPolicyRequest that defines the parameters of the operation.
Returns a PutBucketPolicyResponse from S3.
Initiates the asynchronous execution of the DeleteBucketPolicy operation.
The DeleteBucketPolicyRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteBucketPolicy.
Finishes the asynchronous execution of the DeleteBucketPolicy operation.
The IAsyncResult returned by the call to BeginDeleteBucketPolicy.
Returns a DeleteBucketPolicyResponse from S3.
Deletes the policy associated with the specified bucket. Only the owner
of the bucket can delete the bucket policy.
If you delete a policy that does not exist, Amazon S3 will return a
success (not an error message).
Bucket policies provide access control management at the bucket level for
both the bucket resource and contained object resources. Only one policy
may be specified per-bucket.
For more information on forming bucket polices,
refer:
The DeleteBucketPolicyRequest that defines the parameters of the operation.
Returns a DeleteBucketPolicyResponse from S3.
Initiates the asynchronous execution of the SetNotificationConfiguration operation.
The SetNotificationConfigurationRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSetNotificationConfiguration.
Finishes the asynchronous execution of the SetNotificationConfiguration operation.
The IAsyncResult returned by the call to BeginSetNotificationConfiguration.
Returns a SetNotificationConfigurationResponse from S3.
The notification configuration of a bucket provides near realtime notifications
of events the user is interested in, using SNS as the delivery service.
Notification is turned on by enabling configuration on a bucket, specifying
the events and the SNS topic. This configuration can only be turned
on by the bucket owner. If a notification configuration already exists for the
specified bucket, the new notification configuration will replace the existing
notification configuration. To remove the notification configuration pass in
an empty request. Currently, buckets may only have a single event and topic
configuration.
S3 is eventually consistent. It may take time for the notification status
of a bucket to be propagated throughout the system.
The SetNotificationConfigurationRequest that defines the parameters of the operation.
Returns a SetNotificationConfigurationResponse from S3.
Initiates the asynchronous execution of the GetNotificationConfiguration operation.
The GetNotificationConfigurationRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetNotificationConfiguration.
Finishes the asynchronous execution of the GetNotificationConfiguration operation.
The IAsyncResult returned by the call to BeginGetNotificationConfiguration.
Returns a GetNotificationConfigurationResponse from S3.
Retrieves the notification configuration for the specified bucket. Only the owner of the
bucket can retrieve the notification configuration.
The GetNotificationConfigurationRequest that defines the parameters of the operation.
Returns a GetNotificationConfigurationResponse from S3.
Initiates the asynchronous execution of the ListObjects operation.
The ListObjectsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListObjects.
Finishes the asynchronous execution of the ListObjects operation.
The IAsyncResult returned by the call to BeginListObjects.
Returns a ListObjectsResponse from S3.
The ListObjects operation lists the objects/keys in a bucket ordered
lexicographically (from a-Z). The list can be filtered via the Marker
property of the ListObjectsRequest.
In order to List Objects, you must have READ access to the bucket.
The ListObjectsRequest that defines the parameters of the operation.
Returns a ListObjectsResponse from S3 with a list of S3Objects,
headers and request parameters used to filter the list.
Since buckets can contain a virtually unlimited number of objects, the complete
results of a list query can be extremely large. To manage large result sets,
Amazon S3 uses pagination to split them into multiple responses. Callers should
always check the
to see if the returned listing
is complete, or if callers need to make additional calls to get more results.
The marker parameter allows callers to specify where to start the object listing.
List performance is not substantially affected by the total number of keys in your
bucket, nor by the presence or absence of any additional query parameters.
Initiates the asynchronous execution of the ListVersions operation.
The ListVersionsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListVersions.
Finishes the asynchronous execution of the ListVersions operation.
The IAsyncResult returned by the call to BeginListVersions.
Returns a ListVersionsResponse from S3.
The ListVersions operation returns a list of object versions in the bucket
specified ordered first by key and then by version. Keys are sorted lexicographically
(i.e. alphabetically from a-Z); versions are sorted from most to least recent.
Both versions with data and delete markers are included in the results.
In order to List Versions, you must have READ access to the bucket.
When the list is not filtered by a specific key, only the metadata
associated with the latest version of objects in the bucket is returned.
The use of KeyMarker and VersionIdMarker allow you to filter results.
The ListVersionsRequest that defines the parameters of the operation.
Returns a ListVersionsResponse from S3 that contains a list of
versions along with metadata and the original request parameters.
Since buckets can contain a virtually unlimited number of objects, the complete
results of a list query can be extremely large. To manage large result sets,
Amazon S3 uses pagination to split them into multiple responses. Callers should
always check the
to see if the returned listing
is complete, or if callers need to make additional calls to get more results.
The KeyMarker and VersionIdMarker parameters of the ListVersionsRequest object
allow callers to specify where to start the version listing. In order to enable
versioning on a bucket, please refer to the
SetBucketVersioning
operation's details.
List performance is not substantially affected by the total number of keys in your
bucket, nor by the presence or absence of any additional query parameters.
Initiates the asynchronous execution of the GetACL operation.
The GetACLRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetACL.
Finishes the asynchronous execution of the GetACL operation.
The IAsyncResult returned by the call to BeginGetACL.
Returns a GetACLResponse from S3.
The GetACL operation gets the S3AccessControlList for a given bucket or object.
Each bucket and object in Amazon S3 has an ACL that defines its access control
policy, which is a list of grants. A grant consists of one grantee and one permission.
ACLs only grant permissions; they do not deny them.
The GetACLRequest that defines the parameters of the operation.
Returns a GetACLResponse from S3.
Initiates the asynchronous execution of the SetACL operation.
The SetACLRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndSetACL.
Finishes the asynchronous execution of the SetACL operation.
The IAsyncResult returned by the call to BeginSetACL.
Returns a SetACLResponse from S3.
The SetACL operation sets the S3AccessControlList for a given bucket or object.
Each bucket and object in Amazon S3 has an ACL that defines its access control
policy, which is a list of grants. A grant consists of one grantee and one permission.
ACLs only grant permissions; they do not deny them.
Often used ACLs are defined in the S3CannedACL enumeration.
The SetACLRequest that defines the parameters of the operation.
Returns a SetACLResponse from S3.
Initiates the asynchronous execution of the PutBucket operation.
The PutBucketRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutBucket.
Finishes the asynchronous execution of the PutBucket operation.
The IAsyncResult returned by the call to BeginPutBucket.
Returns a PutBucketResponse from S3.
The PutBucket operation creates a new S3 Bucket.
Depending on your latency and legal requirements, you can specify a location
constraint that will affect where your data physically resides.
The PutBucketRequest that defines the parameters of the operation.
Returns a PutBucketResponse from S3.
Every object stored in Amazon S3 is contained in a bucket. Buckets
partition the namespace of objects stored in Amazon S3 at the top level.
Within a bucket, you can use any names for your objects, but bucket names
must be unique across all of Amazon S3.
Buckets are similar to Internet domain names. Just as Amazon is the only owner
of the domain name Amazon.com, only one person or organization can own a bucket
within Amazon S3. The similarities between buckets and domain names is not a
coincidence - there is a direct mapping between Amazon S3 buckets and subdomains
of s3.amazonaws.com. Objects stored in Amazon S3 are addressable using the REST API
under the domain bucketname.s3.amazonaws.com. For example, the object homepage.html
stored in the Amazon S3 bucket mybucket can be addressed as
http://mybucket.s3.amazonaws.com/homepage.html.
To conform with DNS requirements, the following constraints apply:
- Bucket names should not contain underscores (_)
- Bucket names should be between 3 and 63 characters long
- Bucket names should not end with a dash
- Bucket names cannot contain two, adjacent periods
- Bucket names cannot contain dashes next to periods
(e.g., "my-.bucket.com" and "my.-bucket" are invalid)
- Bucket names cannot contain uppercase characters
There is no limit to the number of objects that can be stored in a bucket and no
variation in performance when using many buckets or just a few. You can store all
of your objects in a single bucket or organize them across several buckets.
Initiates the asynchronous execution of the DeleteBucket operation.
The DeleteBucketRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteBucket.
Finishes the asynchronous execution of the DeleteBucket operation.
The IAsyncResult returned by the call to BeginDeleteBucket.
Returns a DeleteBucketResponse from S3.
The DeleteBucket operation deletes the bucket named in the request.
All objects in the bucket must be deleted before the bucket itself can be deleted.
Only the owner of a bucket can delete it, regardless of the bucket's access control policy.
The DeleteBucketRequest that defines the parameters of the operation.
Returns a DeleteBucketResponse from S3.
Initiates the asynchronous execution of the GetObject operation.
The GetObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetObject.
Finishes the asynchronous execution of the GetObject operation.
The IAsyncResult returned by the call to BeginGetObject.
Returns a GetObjectResponse from S3.
The GetObject operation fetches the most recent version of an S3 object
from the specified S3 bucket. You must have READ access to the object.
If READ access is granted to an anonymous user, an object can be retrieved
without an authorization header. Providing a version-id for the object will
fetch the specific version from S3 instead of the most recent one.
The GetObjectRequest that defines the parameters of the operation.
Returns a GetObjectResponse from S3.
Please wrap the response you get from calling GetObject in a using clause.
This ensures that all underlying IO resources allocated for the response
are disposed once the response has been processed. This is one way to
call GetObject:
using (GetObjectResponse response = s3Client.GetObject(request))
{
... Process the response:
Get the Stream, get the content-length, write contents to disk, etc
}
To see what resources are cleaned up at the end of the using block, please
see
Initiates the asynchronous execution of the GetObjectMetadata operation.
The GetObjectMetadataRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetObjectMetadata.
Finishes the asynchronous execution of the GetObjectMetadata operation.
The IAsyncResult returned by the call to BeginGetObjectMetadata.
Returns a GetObjectMetadataResponse from S3.
The GetObjectMetadata operation is used to retrieve information about a specific object
or object size, without actually fetching the object itself. This is useful if you're
only interested in the object metadata, and don't want to waste bandwidth on the object data.
The response is identical to the GetObject response, except that there is no response body.
The GetObjectMetadataRequest that defines the parameters of the operation.
Returns a GetObjectMetadataResponse from S3.
Initiates the asynchronous execution of the PutObject operation.
The PutObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutObject.
Finishes the asynchronous execution of the PutObject operation.
The IAsyncResult returned by the call to BeginPutObject.
Returns a PutObjectResponse from S3.
The PutObject operation adds an object to an S3 Bucket.
The response indicates that the object has been successfully stored.
Amazon S3 never stores partial objects: if you receive a successful
response, then you can be confident that the entire object was stored.
To ensure data is not corrupted over the network, use the Content-MD5
header. When you use the Content-MD5 header, Amazon S3 checks the object
against the provided MD5 value. If they do not match, Amazon S3 returns an error.
Additionally, you can calculate the MD5 while putting an object to
Amazon S3 and compare the returned Etag to the calculated MD5 value.
If an object already exists in a bucket, the new object will overwrite
it because Amazon S3 stores the last write request. However, Amazon S3
is a distributed system. If Amazon S3 receives multiple write requests
for the same object nearly simultaneously, all of the objects might be
stored, even though only one wins in the end. Amazon S3 does not provide
object locking; if you need this, make sure to build it into your application
layer.
If you specify a location constraint when creating a bucket, all objects
added to the bucket are stored in the bucket's location.
You must have WRITE access to the bucket to add an object.
The PutObjectRequest that defines the parameters of the operation.
Returns a PutObjectResponse from S3.
Initiates the asynchronous execution of the DeleteObject operation.
The DeleteObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteObject.
Finishes the asynchronous execution of the DeleteObject operation.
The IAsyncResult returned by the call to BeginDeleteObject.
Returns a DeleteObjectResponse from S3.
The DeleteObject operation removes the specified object from Amazon S3.
Once deleted, there is no method to restore or undelete an object.
If you delete an object that does not exist, Amazon S3 will return a
success (not an error message).
The DeleteObjectRequest that defines the parameters of the operation.
Returns a DeleteObjectResponse from S3.
Initiates the asynchronous execution of the CopyObject operation.
The CopyObjectRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCopyObject.
Finishes the asynchronous execution of the CopyObject operation.
The IAsyncResult returned by the call to BeginCopyObject.
Returns a CopyObjectResponse from S3.
The copy operation creates a copy of an object that is already stored in Amazon S3.
When copying an object, you can preserve all metadata (default) or specify new metadata.
However, the ACL is not preserved and is set to private for the user making the request.
To override the default ACL setting, specify a new ACL when generating a copy request.
If versioning has been enabled on the source bucket, and you want to copy a specific
version of an object, please use
to specify the
version. By default, the most recent version of an object is copied to the
destination bucket.
The CopyObjectRequest that defines the parameters of the operation.
Returns a CopyObjectResponse from S3.
If Versioning has been enabled on the target bucket, S3 generates a
unique version ID for the object being copied. This version ID is different
from the version ID of the source object. Additionally, S3 returns the version
ID of the copied object in the x-amz-version-id response header in the response.
If you do not enable Versioning or suspend it on the target bucket, the version ID
S3 generates is always the string literal - "null".
Initiates the asynchronous execution of the InitiateMultipartUpload operation.
The InitiateMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndInitiateMultipartUpload.
Finishes the asynchronous execution of the InitiateMultipartUpload operation.
The IAsyncResult returned by the call to BeginInitiateMultipartUpload.
Returns a InitiateMultipartUploadResponse from S3.
This method initiates a multipart upload and returns an InitiateMultipartUploadResponse
which contains an upload ID. This upload ID associates all the
parts in the specific upload. You specify this upload ID in each of
your subsequent Upload Part requests. You also include
this upload ID in the final request to either complete, or abort
the multipart upload request.
The CopyObjectRequest that defines the parameters of the operation.
Returns a InitiateMultipartUploadResponse from S3.
Initiates the asynchronous execution of the UploadPart operation.
The UploadPartRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUploadPart.
Finishes the asynchronous execution of the UploadPart operation.
The IAsyncResult returned by the call to BeginUploadPart.
Returns a UploadPartResponse from S3.
This method uploads a part in a multipart upload. You must initiate a
multipart upload before you can upload any part.
Your UploadPart request must include an upload ID and a part number.
The upload ID is the ID returned by Amazon S3 in response to your
Initiate Multipart Upload request. For more information on initiating a
multipart upload. Part number can be any number between 1 and
10,000, inclusive. A part number uniquely identifies a part and also
defines its position within the object being uploaded. If you
upload a new part using the same part number as an existing part,
that part is overwritten.
To ensure data is not corrupted traversing the network, specify the
Content-MD5 header in the Upload Part request. Amazon S3 checks
the part data against the provided MD5 value. If they do not match,
Amazon S3 returns an error.
When you upload a part, the UploadPartResponse response contains an ETag property.
You should record this ETag property value and the part
number. After uploading all parts, you must send a CompleteMultipartUpload
request. At that time Amazon S3 constructs a complete object by
concatenating all the parts you uploaded, in ascending order based on
the part numbers. The CompleteMultipartUpload request requires you to
send all the part numbers and the corresponding ETag values.
The UploadPartRequest that defines the parameters of the operation.
Returns a UploadPartResponse from S3.
Initiates the asynchronous execution of the CopyPart operation.
The CopyPartRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCopyPart.
Finishes the asynchronous execution of the CopyPart operation.
The IAsyncResult returned by the call to BeginCopyPart.
Returns a CopyPartResponse from S3.
This method creates a part in a multipart upload from an existing Amazon S3 Object.
You must initiate a multipart upload before you can copy a part.
Your CopyPart request must include an upload ID and a part number.
The upload ID is the ID returned by Amazon S3 in response to your
Initiate Multipart Upload request. Part number can be any number between 1 and
10,000, inclusive. A part number uniquely identifies a part and also
defines its position within the object being uploaded. If you
copy a part using the same part number as an existing part, that part is overwritten.
When you copy a part, the CopyPartResponse response contains an ETag property.
You should record this ETag property value and the part
number. After uploading all parts, you must send a CompleteMultipartUpload
request. At that time Amazon S3 constructs a complete object by
concatenating all the parts you uploaded, in ascending order based on
the part numbers. The CompleteMultipartUpload request requires you to
send all the part numbers and the corresponding ETag values.
The CopyPartRequest that defines the parameters of the operation.
Returns a CopyPartResponse from S3.
Initiates the asynchronous execution of the ListParts operation.
The ListPartsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListParts.
Finishes the asynchronous execution of the ListParts operation.
The IAsyncResult returned by the call to BeginListParts.
Returns a ListPartsResponse from S3.
This method lists the parts that have been uploaded
for a particular multipart upload.
This method must include the upload ID, returned by
the InitiateMultipartUpload request. This request
returns a maximum of 1000 uploaded parts by default. You can
restrict the number of parts returned by specifying the
MaxParts property on the ListPartsRequest. If your multipart
upload consists of more parts than allowed in the
ListParts response, the response returns a IsTruncated
field with value true, and a NextPartNumberMarker property.
In subsequent ListParts request you can include the
PartNumberMarker property and set its value to the
NextPartNumberMarker property value from the previous response.
The ListPartsRequest that defines the parameters of the operation.
Returns a ListPartsResponse from S3.
Initiates the asynchronous execution of the AbortMultipartUpload operation.
The AbortMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndAbortMultipartUpload.
Finishes the asynchronous execution of the AbortMultipartUpload operation.
The IAsyncResult returned by the call to BeginAbortMultipartUpload.
Returns a AbortMultipartUploadResponse from S3.
This method aborts a multipart upload. After a multipart upload is
aborted, no additional parts can be uploaded using that upload ID.
The storage consumed by any previously uploaded parts will be freed.
However, if any part uploads are currently in progress, those part
uploads may or may not succeed. As a result, it may be necessary to
abort a given multipart upload multiple times in order to completely free
all storage consumed by all parts.
The AbortMultipartUploadRequest that defines the parameters of the operation.
Returns a AbortMultipartUploadResponse from S3.
Initiates the asynchronous execution of the CompleteMultipartUpload operation.
The CompleteMultipartUploadRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndCompleteMultipartUpload.
Finishes the asynchronous execution of the CompleteMultipartUpload operation.
The IAsyncResult returned by the call to BeginCompleteMultipartUpload.
Returns a CompleteMultipartUploadResponse from S3.
This operation completes a multipart upload by assembling
previously uploaded parts.
You first upload all parts using the UploadPart method.
After successfully uploading all relevant parts of an upload,
you call this operation to complete the upload. Upon receiving
this request, Amazon S3 concatenates all the parts in ascending
order by part number to create a new object. In the
CompleteMultipartUpload request, you must provide the
parts list. For each part in the list, you provide the
part number and the ETag header value, returned after that
part was uploaded.
Processing of a CompleteMultipartUpload request may take
several minutes to complete.
The CompleteMultipartUploadRequest that defines the parameters of the operation.
Returns a CompleteMultipartUploadResponse from S3.
Initiates the asynchronous execution of the ListMultipartUploads operation.
The ListMultipartUploadsRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndListMultipartUploads.
Finishes the asynchronous execution of the ListMultipartUploads operation.
The IAsyncResult returned by the call to BeginListMultipartUploads.
Returns a ListMultipartUploadsResponse from S3.
This operation lists in-progress multipart uploads. An in-progress
multipart upload is a multipart upload that has been initiated,
using the InitiateMultipartUpload request, but has not yet been
completed or aborted.
This operation returns at most 1,000 multipart uploads in the
response by default. The number of multipart uploads can be further
limited using the MaxUploads property on the request parameter. If there are
additional multipart uploads that satisfy the list criteria, the
response will contain an IsTruncated property with the value set to true.
To list the additional multipart uploads use the KeyMarker and
UploadIdMarker properties on the request parameters.
The ListMultipartUploadsRequest that defines the parameters of the operation.
Returns a ListMultipartUploadsResponse from S3.
Initiates the asynchronous execution of the PutBucketWebsite operation.
The PutBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndPutBucketWebsite.
Finishes the asynchronous execution of the PutBucketWebsite operation.
The IAsyncResult returned by the call to BeginPutBucketWebsite.
Returns a PutBucketWebsiteResponse from S3.
This operation enables/configures an S3 Website using the corresponding bucket as the content source.
The website will have one default domain name associated with it, which is the bucket name.
If you attempt to configure an S3 website for a bucket whose name is not compatible with DNS,
Amazon S3 returns an InvalidBucketName error. For more information on bucket names and DNS,
refer to Bucket Restrictions and Limitations
To visit the S3 bucket as a website a new endpoint is created in the following pattern
http://<bucketName>.s3-website-<region>.amazonaws.com/. This is a sample url for a bucket
called example-bucket in the us-east-1 region. http://example-bucket.s3-website-us-east-1.amazonaws.com/
The PutBucketWebsiteRequest that defines the parameters of the operation.
Returns a PutBucketWebsiteResponse from S3.
Initiates the asynchronous execution of the GetBucketWebsite operation.
The GetBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndGetBucketWebsite.
Finishes the asynchronous execution of the GetBucketWebsite operation.
The IAsyncResult returned by the call to BeginGetBucketWebsite.
Returns a GetBucketWebsiteResponse from S3.
This operation retrieves the website configuration for a bucket. The contents of this response
is identical to the content submitted by the user during the PutBucketWebsite operation if it has ever been configured.
The GetBucketWebsiteRequest that defines the parameters of the operation.
Returns a GetBucketWebsiteResponse from S3.
Initiates the asynchronous execution of the DeleteBucketWebsite operation.
The DeleteBucketWebsiteRequest that defines the parameters of
the operation.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDeleteBucketWebsite.
Finishes the asynchronous execution of the DeleteBucketWebsite operation.
The IAsyncResult returned by the call to BeginDeleteBucketWebsite.
Returns a DeleteBucketWebsiteResponse from S3.
This operation removes the website configuration for a bucket.
The DeleteBucketWebsiteRequest that defines the parameters of the operation.
Returns a DeleteBucketWebsiteResponse from S3.
Convert ListBucketsRequest to key/value pairs
Convert GetBucketLocationRequest to key/value pairs.
Convert GetBucketLoggingRequest to key/value pairs.
Convert SetBucketLoggingRequest for enable logging, to key/value pairs.
Convert DisableBucketLoggingRequest for disable logging, to key/value pairs.
Convert ListObjectsRequest to key/value pairs
Convert ListVersionsRequest to key/value pairs
Convert GetAclRequest to key/value pairs.
Convert SetACLRequest to key/value pairs.
Converts the PutBucketRequest to key/value pairs
Convert DeleteBucketRequest to key/value pairs
Convert GetBucketPolicyRequest to key/value pairs.
Convert PutBucketPolicyRequest to key/value pairs.
Convert DeleteBucketPolicyRequest to key/value pairs.
Convert SetNotificationConfigurationRequest to key/value pairs.
Convert GetNotificationConfigurationRequest to key/value pairs.
Convert GetObjectRequest to key/value pairs.
Convert GetObjectMetadataRequest to key/value pairs.
Convert PutObjectRequest to key/value pairs.
Convert GetPreSignedUrlRequest to key/value pairs.
Convert DeleteObjectRequest to key/value pairs.
Convert CopyObjectRequest to key/value pairs.
Convert GetBucketVersioningRequest to key/value pairs.
Convert SetBucketVersioningRequest to key/value pairs.
Convert InitiateMultipartUpload to key/value pairs.
Convert AbortMultipartUploadRequest for enable logging, to key/value pairs.
Convert ListMultipartUploadsRequest for enable logging, to key/value pairs.
Convert ListPartsRequest for enable logging, to key/value pairs.
Convert CompleteMultipartUploadRequest for enable logging, to key/value pairs.
Convert SetBucketLoggingRequest for enable logging, to key/value pairs.
Convert CopyPartRequest for enable logging, to key/value pairs.
Add authentication related and version parameters
Build the Url from the parameters passed in.
Component parts are:
- ServiceURL from the Config
- Bucket
- Key
- urlPrefix
- Query
Configure HttpClient with set of defaults as well as configuration
from AmazonEC2Config instance
Exponential sleep on failed request
Sets the header information to use a S3CannedACL.
The header collection to add the new header to
Enum for the type of canned acl wanted
Sets the If-Match Header in the specified header collection.
Return the object only if its entity tag (ETag) is the same as the one
specified, otherwise return a 412 (precondition failed).
The header collection to add the new header to
The ETag to match against
Set the If-None-Match Header in the specified header collection.
Return the object only if its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).
The header collection to add the new header to
The ETag to match against
Sets the If-Modifed-Since Header in the specified header collection.
Return the object only if it has been modified since the specified time,
otherwise return a 304 (not modified).
The header collection to add the new header to
DateTime Object representing the date to use
Sets the If-Unmodifed-Since Header in the specified header collection.
Return the object only if it has not been modified since the specified time,
otherwise return a 412 (precondition failed).
The header collection to add the new header to
DateTime Object representing the date to use
Sets the If-Match Header for the CopyObject operation in the specified header collection.
Return the object only if its entity tag (ETag) is the same as the one
specified, otherwise return a 412 (precondition failed).
The header collection to add the new header to
The ETag to match against
Sets the If-None-Match Header for the CopyObject operation.
Return the object only if its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).
The header collection to add the new header to
The ETag to match against
Sets the If-Modifed-Since Header for the CopyObject operation.
Return the object only if it has been modified since the specified time,
otherwise return a 304 (not modified).
The header collection to add the new header to
DateTime Object representing the date to use
Sets the If-Unmodifed-Since Header for the CopyObject operation.
Return the object only if it has not been modified since the specified time,
otherwise return a 412 (precondition failed).
The header collection to add the new header to
DateTime Object representing the date to use
Valid values: COPY | REPLACE
Constraints: Values other than COPY or REPLACE result in an immediate 400-based error
response. You cannot copy an object to itself unless the S3MetadataDirective header is
specified and its value set to REPLACE.
The header collection to add the new header to
Either COPY or REPLACE
Sets the x-amz-copy-source header based on the bucket and key passed
as input.
The header collection to add the new header to
The source bucket
The source key
Sets the x-amz-copy-source-range header based on the firstByte and lastByte passed
as input.
The header collection to add the new header to
The position of the first byte to copy
The position of the last byte to copy
Sets the x-amz-version-id header based on the versionId passed as input
The header collection to add the new header to
The versionId of the desired S3 object
Sets the x-amz-mfa based on the serial and token passed as input
The header collection to add the new header to
The tuple of the authentication device codes
Creates a string based on the parameters and encrypts it using
key. Returns the encrypted string.
Returns a string of all x-amz headers sorted by Ordinal.
Unmarshaller for int fields
Unmarshaller for long fields
Unmarshaller for float fields
Unmarshaller for double fields
Unmarshaller for bool fields
Unmarshaller for string fields
Unmarshaller for byte fields
Unmarshaller for DateTime fields
Unmarshaller for MemoryStream fields
Unmarshaller for ResponseMetadata
Response Unmarshaller for RestoreDBInstanceFromDBSnapshot operation
EngineDefaults Unmarshaller
Endpoint Unmarshaller
EC2SecurityGroup Unmarshaller
Delete D B Parameter Group Request Marshaller
Create D B Snapshot Request Marshaller
The results from the RestoreDBInstanceToPointInTime action.
Gets and sets the RestoreDBInstanceToPointInTimeResult property.
Contains the result of a successful invocation of the RestoreDBInstanceToPointInTime
action.
This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
Sets the ReservedDBInstancesOfferingId property
The value to set for the ReservedDBInstancesOfferingId property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Duration property
The value to set for the Duration property
this instance
Sets the FixedPrice property
The value to set for the FixedPrice property
this instance
Sets the UsagePrice property
The value to set for the UsagePrice property
this instance
Sets the CurrencyCode property
The value to set for the CurrencyCode property
this instance
Sets the ProductDescription property
The value to set for the ProductDescription property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
The offering identifier.
The DB instance class for the reserved DB Instance.
The duration of the offering in seconds.
The fixed price charged for this offering.
The hourly price charged for this offering.
The currency code for the reserved DB Instance offering.
The database engine used by the offering.
Indicates if the offering applies to Multi-AZ deployments.
Returns information about the PurchaseReservedDBInstancesOffering response and response metadata.
Gets and sets the PurchaseReservedDBInstancesOfferingResult property.
Contains the result of a successful invocation of the PurchaseReservedDBInstancesOffering
action.
Container for the parameters to the PurchaseReservedDBInstancesOffering operation.
Purchases a reserved DB Instance offering.
Sets the ReservedDBInstancesOfferingId property
The value to set for the ReservedDBInstancesOfferingId property
this instance
Sets the ReservedDBInstanceId property
The value to set for the ReservedDBInstanceId property
this instance
Sets the DBInstanceCount property
The value to set for the DBInstanceCount property
this instance
The ID of the Reserved DB Instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Customer-specified identifier to track this reservation. Example: myreservationID
The number of instances to reserve. Default: 1
Container for the parameters to the ModifyDBParameterGroup operation.
Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName,
ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
The name of the database parameter group. Constraints: - Must be the name of an existing database parameter group
- Must be 1
to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive
hyphens
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method
must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. Valid Values (for the
application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the
pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.
AmazonRDS exception
Constructs a new DBParameterGroupNotFoundException with the specified error
message.
Describes the error encountered.
This data type is used as a response element in the action DescribeDBEngineVersions.
Sets the Engine property
The value to set for the Engine property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the DBEngineDescription property
The value to set for the DBEngineDescription property
this instance
Sets the DBEngineVersionDescription property
The value to set for the DBEngineVersionDescription property
this instance
The name of the database engine.
The version number of the database engine.
The name of the DBParameterGroupFamily for the database engine.
The description of the database engine.
The description of the database engine version.
AmazonRDS exception
Constructs a new AuthorizationAlreadyExistsException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new UnableToCancelJobIdException with the specified error
message.
Describes the error encountered.
CreateJobResult Unmarshaller
AmazonImportExport exception
Constructs a new MultipleRegionsException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new InvalidManifestFieldException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new CreateJobQuotaExceededException with the specified error
message.
Describes the error encountered.
Returns information about the UploadServerCertificateResult response and response metadata.
Gets and sets the UploadServerCertificateResult property.
Contains the result of a successful invocation of the UploadServerCertificate action.
Remove User From Group Request Marshaller
Response Unmarshaller for PutGroupPolicy operation
ListGroupPoliciesResult Unmarshaller
List Account Aliases Request Marshaller
Response Unmarshaller for DeleteServerCertificate operation
Create Group Request Marshaller
The ServerCertificate data type contains information about a
server certificate. This data type is used as a response
element in the action GetServerCertificate.
Sets the ServerCertificateMetadata property
The value to set for the ServerCertificateMetadata property
this instance
Sets the CertificateBody property
The value to set for the CertificateBody property
this instance
Sets the CertificateChain property
The value to set for the CertificateChain property
this instance
The meta information of the server certificate, such as its name, path, ID, and ARN.
The contents of the public key certificate.
Constraints:
-
Length
1 - 16384
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
The contents of the public key certificate chain.
Constraints:
-
Length
1 - 2097152
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]*
Returns information about the PutUserPolicy response metadata.
The PutUserPolicy operation has a void result type.
The MFADevice data type contains information about an MFA
Device. This data type is used as a response element in
the action ListMFADevices.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the SerialNumber property
The value to set for the SerialNumber property
this instance
Sets the EnableDate property
The value to set for the EnableDate property
this instance
The User with whom the MFA device is associated.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Serial number that uniquely identifies the MFA device.
Constraints:
-
Length
9 - 48
-
Pattern
[\w]*
The date when the MFA device was enabled for the User.
Returns information about the ListUsersResult response and response metadata.
Gets and sets the ListUsersResult property.
Contains the result of a successful invocation of the ListUsers action.
Contains the result of a successful invocation of the
ListSigningCertificates action.
Adds elements to the Certificates collection
The values to add to the Certificates collection
this instance
Adds elements to the Certificates collection
The values to add to the Certificates collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of the User's signing certificate information.
A flag that indicates whether there are more certificate IDs to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more certificates in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Contains the result of a successful invocation of the
ListAccountAliases action.
Adds elements to the AccountAliases collection
The values to add to the AccountAliases collection
this instance
Adds elements to the AccountAliases collection
The values to add to the AccountAliases collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A flag that indicates whether there are more account aliases to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more account aliases in the list.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the ListAccessKeysResult response and response metadata.
Gets and sets the ListAccessKeysResult property.
Contains the result of a successful invocation of the ListAccessKeys action.
Contains the result of a successful invocation of the GetUser
action.
Sets the User property
The value to set for the User property
this instance
Information about the User.
Container for the parameters to the GetGroupPolicy operation.
Retrieves the specified policy document for the specified group.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Name of the group the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document to get.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
JobFlowExecutionStatusDetail Unmarshaller
InstanceGroupDetail Unmarshaller
Configuration defining a new instance group.
Sets the Name property
The value to set for the Name property
this instance
Sets the Market property
The value to set for the Market property
this instance
Sets the InstanceRole property
The value to set for the InstanceRole property
this instance
Sets the InstanceType property
The value to set for the InstanceType property
this instance
Sets the InstanceCount property
The value to set for the InstanceCount property
this instance
Friendly name given to the instance group.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Market type of the Amazon EC2 instances used to create a cluster node.
Constraints:
-
Allowed Values
ON_DEMAND
The role of the instance group in the cluster.
Constraints:
-
Allowed Values
MASTER, CORE, TASK
The Amazon EC2 instance type for all instances in the instance group.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Target number of instances for the instance group.
A job flow step consisting of a JAR file whose main function
will be executed. The main function submits a job for Hadoop to
execute and waits for the job to finish or fail.
Adds elements to the Properties collection
The values to add to the Properties collection
this instance
Sets the Jar property
The value to set for the Jar property
this instance
Sets the MainClass property
The value to set for the MainClass property
this instance
Adds elements to the Args collection
The values to add to the Args collection
this instance
A list of Java properties that are set when the step runs. You can use
these properties to pass key value pairs to your main function.
A path to a JAR file run during the step.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the main class in the specified Java file. If not
specified, the JAR file should specify a Main-Class in its manifest
file.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of command line arguments passed to the JAR file's main
function when executed.
Container for the parameters to the AddJobFlowSteps operation.
AddJobFlowSteps adds new steps to a running job flow. A maximum
of 256 steps are allowed in each job flow. A step
specifies the location of a JAR file stored either on the master node
of the job flow or in Amazon S3. Each step is performed by the main
function of the main class of the JAR file. The main class can be
specified either in the manifest of the JAR or by using the
MainFunction parameter of the step. Elastic MapReduce
executes each step in the order listed. For a step to be considered
complete, the main function must exit with a zero exit code and all
Hadoop jobs started while the step was running must have completed and
run successfully. You can only add steps to a job flow
that is in one of the following states: STARTING, BOOTSTAPPING,
RUNNING, or WAITING.
Sets the JobFlowId property
The value to set for the JobFlowId property
this instance
Adds elements to the Steps collection
The values to add to the Steps collection
this instance
A string that uniquely identifies the job flow. This identifier is
returned by RunJobFlow and can also be obtained from
DescribeJobFlows .
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of StepConfig to be executed by the job flow.
InstanceState Unmarshaller
EnableAvailabilityZonesForLoadBalancerResult Unmarshaller
Create L B Cookie Stickiness Policy Request Marshaller
AmazonElasticLoadBalancing exception
Constructs a new DuplicateLoadBalancerNameException with the specified error
message.
Describes the error encountered.
The output for the CreateLoadBalancer action.
Sets the DNSName property
The value to set for the DNSName property
this instance
The DNS name for the LoadBalancer.
Returns information about the CreateLBCookieStickinessPolicyResult response and response metadata.
Gets and sets the CreateLBCookieStickinessPolicyResult property.
The output for the CreateLBCookieStickinessPolicy action.
The AppCookieStickinessPolicy data type.
Default constructor for a new AppCookieStickinessPolicy object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new AppCookieStickinessPolicy object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The mnemonic name for the policy being created. The name must be unique within the set of policies for this
LoadBalancer.
The name of the application cookie used for stickiness.
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the CookieName property
The value to set for the CookieName property
this instance
The mnemonic name for the policy being created. The name must be unique within the set of policies for this LoadBalancer.
The name of the application cookie used for stickiness.
Returns information about the UpdateEnvironmentResult response and response metadata.
Gets and sets the UpdateEnvironmentResult property.
Describes the properties of an environment.
Response Unmarshaller for UpdateApplicationVersion operation
EnvironmentResourceDescription Unmarshaller
CreateApplicationResult Unmarshaller
ConfigurationOptionDescription Unmarshaller
Returns information about the TerminateEnvironmentResult response and response metadata.
Gets and sets the TerminateEnvironmentResult property.
Describes the properties of an environment.
AmazonElasticBeanstalk exception
Constructs a new S3SubscriptionRequiredException with the specified error
message.
Describes the error encountered.
AmazonElasticBeanstalk exception
Constructs a new MissingRequiredParameterException with the specified error
message.
Describes the error encountered.
Returns information about the DescribeEventsResult response and response metadata.
Gets and sets the DescribeEventsResult property.
Result message wrapping a list of event descriptions.
Returns information about the DescribeEnvironmentsResult response and response metadata.
Gets and sets the DescribeEnvironmentsResult property.
Result message containing a list of environment descriptions.
Container for the parameters to the DescribeEnvironments operation.
Returns descriptions for existing environments.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Adds elements to the EnvironmentIds collection
The values to add to the EnvironmentIds collection
this instance
Adds elements to the EnvironmentIds collection
The values to add to the EnvironmentIds collection
this instance
Adds elements to the EnvironmentNames collection
The values to add to the EnvironmentNames collection
this instance
Adds elements to the EnvironmentNames collection
The values to add to the EnvironmentNames collection
this instance
Sets the IncludeDeleted property
The value to set for the IncludeDeleted property
this instance
Sets the IncludedDeletedBackTo property
The value to set for the IncludedDeletedBackTo property
this instance
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
Constraints:
-
Length
1 - 100
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application
version.
Constraints:
-
Length
1 - 100
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are
displayed. false: Do not include deleted environments.
If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
Returns information about the DeleteApplication response metadata.
The DeleteApplication operation has a void result type.
Volume
Sets the VolumeId property
The ID of the volume.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the Size property
The size of the volume, in GiBs.
this instance
Checks if Size property is set
true if Size property is set
Sets the SnapshotId property
Snapshot from which the volume was created (optional).
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the AvailabilityZone property
Availability Zone in which the volume was created.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Status property
Volume state
this instance
Checks if Status property is set
true if Status property is set
Sets the CreateTime property
Time stamp when volume creation was initiated.
this instance
Checks if CreateTime property is set
true if CreateTime property is set
Sets the Attachment property
List of attachments
this instance
Checks if Attachment property is set
true if Attachment property is set
Sets the Tag property
A list of tags for the Volume.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the VolumeId property.
The ID of the volume.
Gets and sets the Size property.
The size of the volume, in GiBs.
Gets and sets the SnapshotId property.
Snapshot from which the volume was created (optional).
Gets and sets the AvailabilityZone property.
Availability Zone in which the volume was created.
Gets and sets the Status property.
Volume state
Gets and sets the CreateTime property.
Time stamp when volume creation was initiated.
Gets and sets the Attachment property.
List of attachments
Gets and sets the Tag property.
A list of tags for the Volume.
Terminate Instances Result
Checks if TerminatingInstance property is set
true if TerminatingInstance property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the TerminatingInstance property.
List of terminating instances
A single Spot Price history data point.
Sets the InstanceType property
The instance type.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the ProductDescription property
The description of the AMI.
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Sets the SpotPrice property
Specifies the price paid to launch one or more
instances.
this instance
Checks if SpotPrice property is set
true if SpotPrice property is set
Sets the Timestamp property
Specifies the creation timestamp of the
request.
this instance
Checks if Timestamp property is set
true if Timestamp property is set
Sets the AvailabilityZone property
The Availability Zone.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Gets and sets the InstanceType property.
The instance type.
Gets and sets the ProductDescription property.
The description of the AMI.
Gets and sets the SpotPrice property.
Specifies the price paid to launch one or more
instances.
Gets and sets the Timestamp property.
Specifies the creation timestamp of the
request.
Gets and sets the AvailabilityZone property.
The Availability Zone.
The Response for the
ReplaceNetworkAclEntry operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
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, go to
Network ACLs in the Amazon Virtual Private Cloud User Guide.
Sets the AssociationId property
The ID representing the current association
between the original network ACL and the
subnet.
this instance
Checks if AssociationId property is set
true if AssociationId property is set
Sets the NetworkAclId property
The ID of the new ACL to associate with the
subnet.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Gets and sets the AssociationId property.
The ID representing the current association
between the original network ACL and the
subnet.
Gets and sets the NetworkAclId property.
The ID of the new ACL to associate with the
subnet.
Sets the VpcId property
The ID of the VPC the Internet gateway is attached to.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the State property
The current state of the attachment.
this instance
Checks if State property is set
true if State property is set
Gets and sets the VpcId property.
The ID of the VPC the Internet gateway is attached to.
Gets and sets the State property.
The current state of the attachment.
ImportKeyPair Result
Checks if KeyName property is set
true if KeyName property is set
Checks if KeyFingerprint property is set
true if KeyFingerprint property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the KeyName property.
The specified unique key pair name.
Gets and sets the KeyFingerprint property.
The MD5 public key fingerprint as specified in section 4 of
RFC4716.
Get Console Output Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if GetConsoleOutputResult property is set
true if GetConsoleOutputResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the GetConsoleOutputResult property.
Get Console Output Result
Information about the EBS block device.
Sets the SnapshotId property
The ID of the snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the VolumeSize property
Size of the volume.
this instance
Checks if VolumeSize property is set
true if VolumeSize property is set
Sets the DeleteOnTermination property
Whether the EBS block device is deleted on
instance termination.
this instance
Checks if DeleteOnTermination property is set
true if DeleteOnTermination property is set
Gets and sets the SnapshotId property.
The ID of the snapshot.
Gets and sets the VolumeSize property.
Size of the volume.
Gets and sets the DeleteOnTermination property.
Whether the EBS block device is deleted on
instance termination.
Disassociate Address Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Detaches an Amazon EBS volume from an instance.
For more information about
Amazon EBS, go
to the Amazon Elastic
Compute Cloud Developer Guide.
Important - make sure to unmount any
file systems on the device within your
operating system before
detaching the volume.
Failure to unmount file systems, or otherwise
properly release the device
from use, can result in
lost data and
will corrupt the file system.
Sets the VolumeId property
The ID of the volume.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Device property
The device name.
this instance
Checks if Device property is set
true if Device property is set
Sets the Force property
Forces detachment if the previous detachment
attempt did not occur
cleanly (logging into an instance,
unmounting the volume, and detaching normally). This option
can lead to data loss or a corrupted file system.
Use this option only as a last resort to detach a volume from a
failed instance. The instance will not have an opportunity
to flush file system caches nor file
system meta data. If you use this option, you
must perform file system check and repair procedures.
this instance
Checks if Force property is set
true if Force property is set
Gets and sets the VolumeId property.
The ID of the volume.
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the Device property.
The device name.
Gets and sets the Force property.
Forces detachment if the previous detachment
attempt did not occur
cleanly (logging into an instance,
unmounting the volume, and detaching normally). This option
can lead to data loss or a corrupted file system.
Use this option only as a last resort to detach a volume from a
failed instance. The instance will not have an opportunity
to flush file system caches nor file
system meta data. If you use this option, you
must perform file system check and repair procedures.
Gives you information about your VPN gateways.
You can filter the results to return information
only about VPN gateways that match criteria you specify. For example,
you could ask to get information about a particular VPN gateway (or all) only
if the gateway's state is pending or available. You can specify
multiple filters (e.g., the VPN gateway is in a particular
Availability Zone and the gateway's state is pending or available).
The result includes information for a particular VPN gateway only if
the gateway matches all your filters. If there's no match, no
special message is returned; the response is simply empty.
The returned information consists of:
1. The VPN gateway ID - The current state of the VPN gateway
(pending, available, deleting, deleted)
2. The type of VPN connection the VPN gateway supports.
3. The Availability Zone where the VPN gateway was created.
4. The VPCs the VPN gateway is attached to and the state of each
attachment (attaching, attached, detaching, detached)
Sets the VpnGatewayId property
A VPN gateway ID.
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Sets the Filter property
The filter to apply on the results of DescribeVpnGateways. Filters
can be:
a. state - The state of the VPN gateway. (pending, available, deleting, deleted).
b. type - The type of VPN gateway. Currently the only supported type is ipsec.1.
c. availabilityZone - The Availability Zone the VPN gateway is in.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the VpnGatewayId property.
A VPN gateway ID.
Gets and sets the Filter property.
The filter to apply on the results of DescribeVpnGateways. Filters
can be:
a. state - The state of the VPN gateway. (pending, available, deleting, deleted).
b. type - The type of VPN gateway. Currently the only supported type is ipsec.1.
c. availabilityZone - The Availability Zone the VPN gateway is in.
Describes the specified Amazon EBS volumes that
you own. If you do not
specify one or
more volume IDs, Amazon EBS
describes all volumes that you own. For
more information about
Amazon EBS, go to the Amazon Elastic Compute Cloud Developer
Guide.
Sets the VolumeId property
The ID of the volume to list.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Volumes.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the VolumeId property.
The ID of the volume to list.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Volumes.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Subnets Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSubnetsResult property is set
true if DescribeSubnetsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSubnetsResult property.
Describe Subnets Result
Describe Snapshot Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSnapshotAttributeResult property is set
true if DescribeSnapshotAttributeResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSnapshotAttributeResult property.
Describe Snapshot Attribute Result
Describe Reserved Instances Result
Checks if ReservedInstances property is set
true if ReservedInstances property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ReservedInstances property.
List of reserved instances
Describes Reserved Instances that you purchased.
For more information about Reserved
Instances, go to the Amazon
Elastic Compute Cloud Developer Guide.
Sets the ReservedInstancesId property
IDs of the Reserved Instance to describe.
this instance
Checks if ReservedInstancesId property is set
true if ReservedInstancesId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified ReservedInstancesOfferings.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the ReservedInstancesId property.
IDs of the Reserved Instance to describe.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified ReservedInstancesOfferings.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Addresses Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeAddressesResult property is set
true if DescribeAddressesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeAddressesResult property.
Describe Addresses Result
Lists elastic IP addresses assigned to your
account or provides information about a
specific address.
Sets the PublicIp property
Elastic IP address to describe.
this instance
Checks if PublicIp property is set
true if PublicIp property is set
Sets the AllocationId property
One or more allocation IDs corresponding to the address
or addresses to describe. Applies only to VPC addresses.
this instance
Checks if AllocationId property is set
true if AllocationId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified DescribeAddresses.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the PublicIp property.
Elastic IP address to describe.
Gets and sets the AllocationId property.
One or more allocation IDs corresponding to the address
or addresses to describe. Applies only to VPC addresses.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified DescribeAddresses.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Deletes a route table from a VPC. The route table must not be associated with a subnet.You can't delete
the main route table. For more information about route tables, go to Route Tables in the Amazon Virtual
Private Cloud User Guide.
Sets the RouteTableId property
The ID of the route table to be deleted.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Gets and sets the RouteTableId property.
The ID of the route table to be deleted.
Deletes a set of DHCP options that you specify. Amazon VPC returns an
error if the set of options you specify is currently associated with
a VPC. You can disassociate the set of options by associating
either a new set of options or the default options with the VPC.
Sets the DhcpOptionsId property
The ID of the DHCP options set you want to
delete.
this instance
Checks if DhcpOptionsId property is set
true if DhcpOptionsId property is set
Gets and sets the DhcpOptionsId property.
The ID of the DHCP options set you want to
delete.
Create Volume Result
Checks if Volume property is set
true if Volume property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Volume property.
Volume
Adds or overwrites tags for the specified resources.
Each resource can have a maximum of 10 tags.
Each tag consists of a key-value pair.
Tag keys must be unique per resource.
Sets the ResourceId property
One or more IDs of resources to tag.
this instance
Checks if ResourceId property is set
true if ResourceId property is set
Sets the Tag property
The tags to add or overwrite for the specified resources.
Each tag item consists of a
key-value pair.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the ResourceId property.
One or more IDs of resources to tag.
Gets and sets the Tag property.
The tags to add or overwrite for the specified resources.
Each tag item consists of a
key-value pair.
Provides information to AWS about your customer gateway device. The
customer gateway is the appliance at your end of the VPN connection
(compared to the VPN gateway, which is the device at the AWS side of the
VPN connection). AWS might delete any customer gateway that you create
with this operation if you leave it inactive for an extended period of
time (inactive means that there's no VPN connection in use with the customer
gateway).
You must provide the Internet-routable IP address of the customer
gateway's external interface. The IP address must be static and can't be
behind a device performing network address translation (NAT).
You must also provide the device's Border Gateway Protocol (BGP)
Autonomous System Number (ASN). You can use an existing ASN
assigned to your network. If you don't have an ASN already, you can
use a private ASN (in the 64512 - 65534 range)
Sets the Type property
The type of VPN connection this customer gateway supports.
this instance
Checks if Type property is set
true if Type property is set
Sets the IpAddress property
The Internet-routable IP address for the customer gateway's
outside interface. The address must be static.
this instance
Checks if IpAddress property is set
true if IpAddress property is set
Sets the BgpAsn property
The customer gateway's Border Gateway Protocol
(BGP) Autonomous System Number (ASN).
this instance
Checks if BgpAsn property is set
true if BgpAsn property is set
Gets and sets the Type property.
The type of VPN connection this customer gateway supports.
Gets and sets the IpAddress property.
The Internet-routable IP address for the customer gateway's
outside interface. The address must be static.
Gets and sets the BgpAsn property.
The customer gateway's Border Gateway Protocol
(BGP) Autonomous System Number (ASN).
Set Alarm State Request Marshaller
AmazonCloudWatch exception
Constructs a new ResourceNotFoundException with the specified error
message.
Describes the error encountered.
The Metric data type contains information about a
specific metric. If you call ListMetrics, Amazon CloudWatch returns
information contained by this data type.
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the MetricName property
The value to set for the MetricName property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
The namespace of the metric.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The name of the metric.
Constraints:
-
Length
1 - 255
A list of dimensions associated with the metric.
Constraints:
-
Length
0 - 10
The output for the ListMetrics action.
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of metrics used to generate statistics for an AWS account.
A string that marks the start of the next batch of returned results.
Returns information about the DescribeAlarmHistoryResult response and response metadata.
Gets and sets the DescribeAlarmHistoryResult property.
The output for the DescribeAlarmHistory action.
The CreateDistributionRequest contains the parameters used for the CreateDistribution operation.
Sets the DistributionConfig property for this request.
The value that DistributionConfig is set to
the request with the Id set
Gets and Sets the DistributionConfig property.
Describes the elements shared by the various distribution configurations.
The elements shared between configuration objects are:
- Caller Reference
- Origin S3 Bucket
- Comment
- A list of CNAMEs for the distribution
- Enabled flag
- Bucket Logging details
- CloudFront Origin Access Identity associated with the distribution.
This is a virtual identity you use to let CloudFront fetch private content
from your bucket.
- The AWS Accounts that have URL signing privileges for Private Content.
For more information, please visit:
-
-
Returns the string representation of this object.
A string representing the configuration.
Checks if Comment property is set.
true if Comment property is set.
Checks if CallerReference property is set
true if CallerReference property is set
Checks if CNAME property is set
true if CNAME property is set
Checks if ETag property is set.
true if ETag property is set.
Checks if TrustedSigners property is set.
true if TrustedSigners property is set.
Checks if the Logging property is set.
true if the Logging property is set.
Gets and sets the S3Origin property.
The S3Origin contains the Amazon S3 bucket that will be used for the Distribution.
Gets and sets the Origin property.
The Amazon S3 bucket to associate with the distribution.
For example: mybucket.s3.amazonaws.com.
Gets and sets the Comment property.
Any comments you want to include about the distribution.
The maximum length of the comment is 128 characters
Gets and sets the CallerReference property.
A unique number that ensures the request can't be replayed.
If the CallerReference is new (no matter the content of the CloudFrontDistributionConfig object),
a new distribution is created.
If the CallerReference is a value you already sent in a previous request to
create a distribution, and the content of the CloudFrontDistributionConfig is identical to the
original request (ignoring white space), the response includes the same information
returned to the original request.
If the CallerReference is a value you already sent in a previous request to
create a distribution but the content of the CloudFrontDistributionConfig is different from the
original request, CloudFront returns a DistributionAlreadyExists error.
Gets and Sets the CNAME property.
A CNAME alias you want to associate with this distribution. You can have up to
10 CNAME aliases per distribution. For more information, refer:
Only include a CNAME element if you have a CNAME to associate with the distribution.
Don't include an empty CNAME element in the CloudFrontDistributionConfig object. If you do, CloudFront
returns a MalformedXML error. Only 10 CNAME aliases can be specified for a distribution.
Gets and sets the Enabled property.
Whether the distribution is enabled to accept
end user requests for content.
Gets and sets the ETag property of the Distribution Config.
The ETag is the current version of the Distribution's
Configuration.
Gets and sets the OriginAccessIdentity property.
The CloudFront origin access identity to associate with the distribution.
If you want the distribution to serve private content, include this element;
if you want the distribution to serve public content, remove this element.
Gets and sets the TrustedSigners property.
This specifies any AWS accounts you want to permit to create signed URLs for private content.
Gets and Sets the Logging property.
A complex type that controls whether access logs are written for the
distribution. For more information, refer:
The Bucket specifies where the CloudFront access logs will be stored. Maximum length is 128
characters and it must conform to Amazon S3 V2 bucket criteria.
The Prefix is an optional string of your choice to prefix to the access log
filenames for this distribution. Maximum length is 256 characters and it can't
start with a '/'
Amazon CloudFront Exception provides details of errors
returned by Amazon CloudFront service
Initializes a new AmazonCloudFrontException with default values.
Initializes a new AmazonCloudFrontException with a specified error message
A message that describes the error
Initializes a new AmazonCloudFrontException from the inner exception that is
the cause of this exception.
The nested exception that caused the AmazonCloudFrontException
Initializes a new AmazonCloudFrontException with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Serializes this instance of AmazonCloudFrontException.
The object that holds the serialized object data.
The contextual information about the source or destination.
Initializes a new AmazonCloudFrontException with a specific error message and the inner exception
that is the cause of this exception.
Overview of error
The exception that is the cause of the current exception.
If the innerException parameter is not a null reference, the current exception is
raised in a catch block that handles the inner exception.
Initializes an AmazonCloudFrontException with a specific message and
HTTP status code
Overview of error
HTTP status code for error response
Initializes an AmazonCloudFrontException with error information provided in an
AmazonCloudFront response.
Overview of error
HTTP status code for error response
Error Code returned by the service
Request ID returned by the service
Error Type
Compete xml found in response
The CloudFront request url
The response headers containing CloudFront specific information
Gets the HostId property.
Gets the ErrorCode property.
Gets error message
Gets status code returned by the service if available. If status
code is set to -1, it means that status code was unavailable at the
time exception was thrown
Gets XML returned by the service if available.
Gets Request ID returned by the service if available.
Gets the CloudFront service address used to make this request.
Gets the error response HTTP headers so that CloudFront specific information
can be retrieved for debugging. Interesting fields are:
a. x-amz-id-2
b. x-amz-request-id
c. Date
A value can be retrieved from this HeaderCollection via:
ResponseHeaders.Get("key");
Returns information about the ValidateTemplateResult response and response metadata.
Gets and sets the ValidateTemplateResult property.
The output for ValidateTemplate action.
TemplateParameter Unmarshaller
StackSummary Unmarshaller
The StackResourceDetail data type.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the StackId property
The value to set for the StackId property
this instance
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
Sets the PhysicalResourceId property
The value to set for the PhysicalResourceId property
this instance
Sets the ResourceType property
The value to set for the ResourceType property
this instance
Sets the LastUpdatedTimestamp property
The value to set for the LastUpdatedTimestamp property
this instance
Sets the ResourceStatus property
The value to set for the ResourceStatus property
this instance
Sets the ResourceStatusReason property
The value to set for the ResourceStatusReason property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the Metadata property
The value to set for the Metadata property
this instance
The name associated with the stack.
Unique identifier of the stack.
The logical name of the resource specified in the template.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
Type of the resource. (For more information, go to the AWS
CloudFormation User Guide.)
Time the status was updated.
Current status of the resource.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
Success/failure message associated with the resource.
User defined description associated with the resource.
The JSON format content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS
CloudFormation User Guide.
The output for a ListStackResources action.
Adds elements to the StackResourceSummaries collection
The values to add to the StackResourceSummaries collection
this instance
Adds elements to the StackResourceSummaries collection
The values to add to the StackResourceSummaries collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of StackResourceSummary structures.
String that identifies the start of the next list of events, if there is one.
Constraints:
-
Length
1 - 1024
Response Unmarshaller for TerminateInstanceInAutoScalingGroup operation
Set Instance Health Request Marshaller
Response Unmarshaller for EnableMetricsCollection operation
AmazonAutoScaling exception
Constructs a new ScalingActivityInProgressException with the specified error
message.
Describes the error encountered.
AmazonAutoScaling exception
Constructs a new ResourceInUseException with the specified error
message.
Describes the error encountered.
AmazonAutoScaling exception
Constructs a new LimitExceededException with the specified error
message.
Describes the error encountered.
Returns information about the DisableMetricsCollection response metadata.
The DisableMetricsCollection operation has a void result type.
Returns information about the DescribeMetricCollectionTypesResult response and response metadata.
Gets and sets the DescribeMetricCollectionTypesResult property.
The output of the DescribeMetricCollectionTypes action.
The LaunchConfigurationsType data type.
Adds elements to the LaunchConfigurations collection
The values to add to the LaunchConfigurations collection
this instance
Adds elements to the LaunchConfigurations collection
The values to add to the LaunchConfigurations collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of launch configurations.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the DescribeAutoScalingGroups operation.
Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of
the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. This action
supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned
token as the NextToken parameter.
Adds elements to the AutoScalingGroupNames collection
The values to add to the AutoScalingGroupNames collection
this instance
Adds elements to the AutoScalingGroupNames collection
The values to add to the AutoScalingGroupNames collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
A list of Auto Scaling group names.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The maximum number of records to return.
Constraints:
-
Range
1 - 50
Container for the parameters to the DescribeAdjustmentTypes operation.
Returns policy adjustment types for use in the PutScalingPolicy action.
The BlockDeviceMapping data type.
Sets the VirtualName property
The value to set for the VirtualName property
this instance
Sets the DeviceName property
The value to set for the DeviceName property
this instance
Sets the Ebs property
The value to set for the Ebs property
this instance
The virtual name associated with the device.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the device within Amazon EC2.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Elastic Block Storage volume information.
A factory for creating conditions to be used in the policy.
Condition key for the canned ACL specified by a request.
This condition key may only be used with enum.
Condition key for the location constraint specified by a request.
This condition key may only be used with enum.
Condition key for the prefix specified by a request.
This condition key may only be used with enum.
Condition key for the delimiter specified by a request.
This condition key may only be used with enum.
Condition key for the max keys specified by a request.
This condition key may only be used with enum.
Condition key for the source object specified by a request to copy an
object.
This condition key may only be used with enum.
Condition key for the metadata directive specified by a request to copy
an object.
This condition key may only be used with enum.
Condition key for the version ID of an object version specified by a
request.
This condition key may only be used with enum.
Condition key for the current time.
This condition key should only be used with enum.
Condition key for whether or not an incoming request is using a secure
transport to make the request (i.e. HTTPS instead of HTTP).
This condition key should only be used with the boolean overload of NewCondition.
Condition key for the source IP from which a request originates.
This condition key should only be used with enum.
Condition key for the user agent included in a request.
This condition key should only be used with
enum.
Condition key for the current time, in epoch seconds.
This condition key should only be used with enum.
objects.
Condition key for the referrer specified by a request.
This condition key should only be used with
objects.
Condition key for the Amazon Resource Name (ARN) of the source specified
in a request. The source ARN indicates which resource is affecting the
resource listed in your policy. For example, an SNS topic is the source
ARN when publishing messages from the topic to an SQS queue.
This condition key should only be used with enum.
Condition key for The URL, e-mail address, or ARN from a Subscribe
request or a previously confirmed subscription. Use with string
conditions to restrict access to specific endpoints (e.g.,
*@mycompany.com).
This condition key may only be used with enum.
Condition key for the protocol value from a Subscribe request or a
previously confirmed subscription. Use with string conditions to restrict
publication to specific delivery protocols (e.g., HTTPS).
This condition key may only be used with enum.
Constructs a new access policy condition that compares an Amazon S3
canned ACL with the canned ACL specified by an incoming request.
You can use this condition to ensure that any objects uploaded to an
Amazon S3 bucket have a specific canned ACL set.
The Amazon S3 canned ACL to compare against.
A new access control policy condition that compares the Amazon S3
canned ACL specified in incoming requests against the value
specified.
Constructs a new access control policy condition that compares ARNs (Amazon Resource Names).
The access policy condition key specifying where to get the first ARN for the comparison
The type of comparison to perform.
The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the
multi-character wildcard (*) or the single-character wildcard
Constructs a new access policy condition that performs a boolean
comparison.
The access policy condition key specifying where to get the
first boolean value for the comparison (ex: aws:SecureTransport).
The boolean to compare against.
Constructs a new access policy condition that compares the current time
(on the AWS servers) to the specified date.
The type of comparison to perform. For example,
DateComparisonType.DateLessThan will cause this policy
condition to evaluate to true if the current date is less than
the date specified in the second argument.
The date to compare against.
Constructs a new access policy condition that compares the source IP
address of the incoming request to an AWS service against the specified
CIDR range. The condition evaluates to true (meaning the policy statement
containing it will be applied) if the incoming source IP address is
within that range.
To achieve the opposite effect (i.e. cause the condition to evaluate to
true when the incoming source IP is not in the specified CIDR
range) use the alternate constructor form and specify
IpAddressComparisonType.NotIpAddress.
The CIDR IP range involved in the policy condition.
Constructs a new access policy condition that compares the source IP
address of the incoming request to an AWS service against the specified
CIDR range. When the condition evaluates to true (i.e. when the incoming
source IP address is within the CIDR range or not) depends on the
specified IpAddressComparisonType.
The type of comparison to to perform.
The CIDR IP range involved in the policy condition.
Constructs a new access policy condition that compares two numbers.
The type of comparison to perform.
The access policy condition key specifying where to get the
first number for the comparison.
The second number to compare against.
Constructs a new access control policy condition that compares two
strings.
The type of comparison to perform
The access policy condition key specifying where to get the
first string for the comparison (ex: aws:UserAgent).
The second string to compare against. When using
StringComparisonType.StringLike or
StringComparisonType.StringNotLike this may contain
the multi-character wildcard (*) or the single-character
wildcard (?).
Constructs a new access policy condition that compares the Amazon
Resource Name (ARN) of the source of an AWS resource that is modifying
another AWS resource with the specified pattern.
For example, the source ARN could be an Amazon SNS topic ARN that is
sending messages to an Amazon SQS queue. In that case, the SNS topic ARN
would be compared the ARN pattern specified here.
The endpoint pattern may optionally contain the multi-character wildcard
* (*) or the single-character wildcard (?). Each of the six colon-delimited
components of the ARN is checked separately and each can include a
wildcard.
Policy policy = new Policy("MyQueuePolicy");
policy.WithStatements(new Statement(Statement.StatementEffect.Allow)
.WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage)
.WithResources(new Resource(myQueueArn))
.WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn)));
The ARN pattern against which the source ARN will be compared.
Each of the six colon-delimited components of the ARN is
checked separately and each can include a wildcard.
A new access control policy condition that compares the ARN of
the source specified in an incoming request with the ARN pattern
specified here.
Constructs a new access control policy condition that tests if the
incoming request was sent over a secure transport (HTTPS).
A new access control policy condition that tests if the incoming
request was sent over a secure transport (HTTPS).
Constructs a new access policy condition that compares the requested
endpoint used to subscribe to an Amazon SNS topic with the specified
endpoint pattern. The endpoint pattern may optionally contain the
multi-character wildcard (*) or the single-character wildcard (?).
For example, this condition can restrict subscriptions to a topic to
email addresses in a certain domain ("*@my-company.com").
Policy policy = new Policy("MyTopicPolicy");
policy.WithStatements(new Statement(Statement.StatementEffect.Allow)
.WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe)
.WithResources(new Resource(myTopicArn))
.WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com")));
The endpoint pattern against which to compare the requested
endpoint for an Amazon SNS topic subscription.
A new access control policy condition that compares the endpoint
used in a request to subscribe to an Amazon SNS topic with the
endpoint pattern specified.
Constructs a new AWS access control policy condition that allows an
access control statement to restrict subscriptions to an Amazon SNS topic
based on the protocol being used for the subscription. For example, this
condition can restrict subscriptions to a topic to endpoints using HTTPS
to ensure that messages are securely delivered.
The protocol against which to compare the requested protocol
for an Amazon SNS topic subscription.
A new access control policy condition that compares the
notification protocol requested in a request to subscribe to an
Amazon SNS topic with the protocol value specified.
Enumeration of the supported ways an ARN comparison can be evaluated.
Exact matching
Loose case-insensitive matching of the ARN. Each of the six
colon-delimited components of the ARN is checked separately and each
can include a multi-character match wildcard (*) or a
single-character match wildcard (?).
Negated form of ArnEquals
Negated form of ArnLike
Enumeration of the supported ways a date comparison can be evaluated.
Enumeration of the supported ways an IP address comparison can be evaluated.
Matches an IP address against a CIDR IP range, evaluating to true if
the IP address being tested is in the condition's specified CIDR IP
range.
Negated form of IpAddress
Enumeration of the supported ways a numeric comparison can be evaluated
Enumeration of the supported ways a string comparison can be evaluated.
Case-sensitive exact string matching
Case-insensitive string matching
Loose case-insensitive matching. The values can include a
multi-character match wildcard (*) or a single-character match
wildcard (?) anywhere in the string.
Negated form of StringEquals.
Negated form of StringEqualsIgnorecase.
Negated form of StringLike.
a general purpose ASN.1 decoder - note: this class differs from the
others in that it returns null after it has read the last object in
the stream. If an ASN.1 Null is encountered a Der/BER Null object is
returned.
Create an ASN1InputStream where no DER object will be longer than limit.
@param input stream containing ASN.1 encoded data.
@param limit maximum size of a DER encoded object.
Create an ASN1InputStream based on the input byte array. The length of DER objects in
the stream is automatically limited to the length of the input array.
@param input array containing ASN.1 encoded data.
build an object given its tag and the number of bytes to construct it from.
Configuration for accessing Amazon SQS service
Sets the SignatureMethod property
SignatureMethod property
this instance
Checks if SignatureMethod property is set
true if SignatureMethod property is set
Sets the SignatureVersion property
SignatureVersion property
this instance
Checks if SignatureVersion property is set
true if SignatureVersion property is set
Sets the UserAgent property
UserAgent property
this instance
Checks if UserAgent property is set
true if UserAgent property is set
Sets the ServiceURL property
ServiceURL property
this instance
Checks if ServiceURL property is set
true if ServiceURL property is set
Sets the ProxyHost property
ProxyHost property
this instance
Checks if ProxyHost property is set
true if ProxyHost property is set
Sets the ProxyPort property
ProxyPort property
this instance
Checks if ProxyPort property is set
true if ProxyPort property is set
Sets the MaxErrorRetry property
MaxErrorRetry property
this instance
Checks if MaxErrorRetry property is set
true if MaxErrorRetry property is set
Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Whether a secure string should be used or not.
The Config object with the property set
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Sets the ProxyUsername property
Value for the ProxyUsername property
this instance
Checks if ProxyUsername property is set
true if ProxyUsername property is set
Sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
ProxyPassword property
this instance
Checks if ProxyPassword property is set
true if ProxyPassword property is set
Gets Service Version
Gets and sets of the signatureMethod property.
Gets and sets of the SignatureVersion property.
Gets and sets of the UserAgent property.
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint or want to switch between https and http.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureStringForAwsSecretKey property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
Encapsulates the result of the Subscribe action.
Checks if SubscriptionArn property is set
true if SubscriptionArn property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SubscriptionArn property.
Represents a unique message ID returned from a successful
SendRawEmail request.
Sets the MessageId property
The value to set for the MessageId property
this instance
The unique message identifier returned from the SendRawEmail action.
Represents the destination of the message, consisting of To:,
CC:, and BCC: fields.
Default constructor for a new Destination object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Destination object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The To: field(s) of the message.
Adds elements to the ToAddresses collection
The values to add to the ToAddresses collection
this instance
Adds elements to the ToAddresses collection
The values to add to the ToAddresses collection
this instance
Adds elements to the CcAddresses collection
The values to add to the CcAddresses collection
this instance
Adds elements to the CcAddresses collection
The values to add to the CcAddresses collection
this instance
Adds elements to the BccAddresses collection
The values to add to the BccAddresses collection
this instance
Adds elements to the BccAddresses collection
The values to add to the BccAddresses collection
this instance
The To: field(s) of the message.
The CC: field(s) of the message.
The BCC: field(s) of the message.
Perform multiple DeleteAttributes operations in a single call. This helps you yield savings in round trips and
latencies, and enables Amazon SimpleDB to optimize requests, which generally yields better throughput.
Amazon SimpleDB uniquely identifies attributes in an item by their name/value combinations. For example, a
single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However,
it cannot have two attribute instances where both the attribute name and attribute value are the same.
Note: You cannot specify an empty string as an item or attribute name.
The operation succeeds or fails in its entirety. There are no partial deletes.
You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of
concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses.
This operation is vulnerable to exceeding the maximum URL size.
The following limitations are enforced for this operation:
* 256 attribute name-value pairs per item
* 1 MB request size
* 1 billion attributes per domain
* 10 GB of total user data storage per domain
* 25 item limit per BatchDeleteAttributes operation
Sets the DomainName property
The name of the domain in which to perform the operation.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the Item property
Items represent individual objects that contain one or more attribute name-value pairs.
this instance
Checks if Item property is set
true if Item property is set
Gets and sets the DomainName property.
The name of the domain in which to perform the operation.
Gets and sets the Item property.
Items represent individual objects that contain one or more attribute name-value pairs.
The PutBucketPolicyResponse contains any headers returned by S3.
The DeleteObjectResponse contains any headers returned by S3.
Gets and sets the IsDeleteMarker property.
Specifies whether the object deleted was (true) or
was not (false) a Delete Marker.
Gets and sets the Headers property.
The PutBucketWebsiteRequest contains the parameters used for the PutBucketWebsiteRequest operation.
Required Parameters: BucketName, WebsiteConfiguration.IndexDocumentSuffix
Sets the BucketName property for this request.
This is the S3 Bucket where the website configuration will be put.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the WithWebsiteConfiguration property for this request.
The value that WithWebsiteConfiguration is set to
the request with the WebsiteConfiguration set
Gets and sets the BucketName property.
Gets and sets the WebsiteConfiguration property.
This is where the index document suffix and custom error page are defined.
PendingModifiedValues Unmarshaller
Modify D B Parameter Group Request Marshaller
Response Unmarshaller for ModifyDBInstance operation
Response Unmarshaller for DescribeDBSecurityGroups operation
Response Unmarshaller for DeleteDBParameterGroup operation
Result Unmarshaller for CreateDBInstanceReadReplica operation
Container for the parameters to the RevokeDBSecurityGroupIngress operation.
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. Required parameters for this API
are one of CIDRIP or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the CIDRIP property
The value to set for the CIDRIP property
this instance
Sets the EC2SecurityGroupName property
The value to set for the EC2SecurityGroupName property
this instance
Sets the EC2SecurityGroupOwnerId property
The value to set for the EC2SecurityGroupOwnerId property
this instance
The name of the DB Security Group to revoke ingress from.
The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName and
EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group to revoke access from. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must
also be provided and CIDRIP cannot be provided.
The AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is
not an acceptable value. If EC2SecurityGroupOwnerId is specified EC2SecurityGroupName must also be provided and CIDRIP
cannot be provided.
Returns information about the RestoreDBInstanceToPointInTime response and response metadata.
Gets and sets the RestoreDBInstanceToPointInTimeResult property.
Contains the result of a successful invocation of the RestoreDBInstanceToPointInTime
action.
Returns information about the ModifyDBParameterGroupResult response and response metadata.
Gets and sets the ModifyDBParameterGroupResult property.
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
AmazonRDS exception
Constructs a new InstanceQuotaExceededException with the specified error
message.
Describes the error encountered.
Container for the parameters to the DescribeDBEngineVersions operation.
Returns a list of the available DB engines.
Sets the Engine property
The value to set for the Engine property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the DefaultOnly property
The value to set for the DefaultOnly property
this instance
The database engine to return.
The database engine version to return. Example: 5.1.49
The name of a specific database parameter group family to return details for. Constraints: - Must be 1 to 255 alphanumeric
characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the
response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to
MaxRecords.
Indicates that only the default version of the specified engine or engine and major version combination is returned.
The results from the DeleteDBInstance action.
Gets and sets the DeleteDBInstanceResult property.
Contains the result of a successful invocation of the DeleteDBInstance
action.
Container for the parameters to the CreateDBSnapshot operation.
Creates a DBSnapshot. The source DBInstance must be in "available" state.
Sets the DBSnapshotIdentifier property
The value to set for the DBSnapshotIdentifier property
this instance
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
The identifier for the DB Snapshot. Constraints: - Cannot be null, empty, or blank
- Must contain from 1 to 255 alphanumeric
characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive. Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen
or contain two consecutive hyphens
Job Unmarshaller
AmazonImportExport exception
Constructs a new InvalidJobIdException with the specified error
message.
Describes the error encountered.
Returns information about the GetStatusResult response and response metadata.
Gets and sets the GetStatusResult property.
Output structure for the GetStatus operation.
Container for the parameters to the CancelJob operation.
This operation cancels a specified job. Only the job owner can
cancel it. The operation fails if the job has already started or is
complete.
Sets the JobId property
The value to set for the JobId property
this instance
A unique identifier which refers to a particular job.
Configuration for accessing AWS Import/Export Service service
Default constructor
Gets the ServiceVersion property.
Container for the parameters to the UpdateUser operation.
Updates the name and/or the path of the specified User.
IMPORTANT: You should understand the implications of
changing a User's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a User name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Bob to Robert, the entity making the
request must have permission on Bob and Robert, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the NewPath property
The value to set for the NewPath property
this instance
Sets the NewUserName property
The value to set for the NewUserName property
this instance
Name of the User to update. If you're changing the name of the User, this is the original User name.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
New path for the User. Include this parameter only if you're changing the User's path.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
New name for the User. Include this parameter only if you're changing the User's name.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
GetUserPolicyResult Unmarshaller
GetServerCertificateResult Unmarshaller
Response Unmarshaller for GetLoginProfile operation
Response Unmarshaller for DeleteAccessKey operation
Create Account Alias Request Marshaller
Create Access Key Request Marshaller
Contains the result of a successful invocation of the
ListMFADevices action.
Adds elements to the MFADevices collection
The values to add to the MFADevices collection
this instance
Adds elements to the MFADevices collection
The values to add to the MFADevices collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of MFA devices.
A flag that indicates whether there are more User names to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more User names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Contains the result of a successful invocation of the
GetUserPolicy action.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the PolicyDocument property
The value to set for the PolicyDocument property
this instance
The User the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The name of the policy.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The policy document.
Constraints:
-
Length
1 - 131072
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Contains the result of a successful invocation of the GetGroup
action.
Sets the Group property
The value to set for the Group property
this instance
Adds elements to the Users collection
The values to add to the Users collection
this instance
Adds elements to the Users collection
The values to add to the Users collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Information about the group.
A list of Users in the group.
A flag that indicates whether there are more User names to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more User names in the list.
If IsTruncated is true, then this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the DeleteUser response metadata.
The DeleteUser operation has a void result type.
Container for the parameters to the DeleteSigningCertificate operation.
Deletes the specified signing certificate associated with the
specified User. If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the CertificateId property
The value to set for the CertificateId property
this instance
Name of the User the signing certificate belongs to.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
ID of the signing certificate to delete.
Constraints:
-
Length
24 - 128
-
Pattern
[\w]*
Container for the parameters to the CreateLoginProfile operation.
Creates a login profile for the specified User, giving the User
the ability to access AWS services such as the AWS Management Console.
For more information about login profiles, see Managing Login
Profiles and MFA Devices in Using AWS Identity and Access
Management .
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Password property
The value to set for the Password property
this instance
Name of the User to create a login profile for.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The new password for the User name.
Constraints:
-
Length
1 - 128
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
StepConfig Unmarshaller
Response Unmarshaller for DescribeJobFlows operation
LBCookieStickinessPolicy Unmarshaller
DeregisterInstancesFromLoadBalancerResult Unmarshaller
AmazonElasticLoadBalancing exception
Constructs a new TooManyPoliciesException with the specified error
message.
Describes the error encountered.
AmazonElasticLoadBalancing exception
Constructs a new DuplicateListenerException with the specified error
message.
Describes the error encountered.
Container for the parameters to the DescribeLoadBalancers operation.
Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns
configuration information for all LoadBalancers created by the caller. NOTE: The client must have created the specified
input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to
create the LoadBalancer.
Default constructor for a new DescribeLoadBalancersRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DescribeLoadBalancersRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
A list of names associated with the LoadBalancers at creation time.
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
A list of names associated with the LoadBalancers at creation time.
Returns information about the DeregisterInstancesFromLoadBalancerResult response and response metadata.
Gets and sets the DeregisterInstancesFromLoadBalancerResult property.
The output for the DeregisterInstancesFromLoadBalancer action.
The output for the CreateLoadBalancerListeners action.
Result message wrapping a single description of an application version.
Sets the ApplicationVersion property
The value to set for the ApplicationVersion property
this instance
The ApplicationVersionDescription of the application version.
SolutionStackDescription Unmarshaller
LaunchConfiguration Unmarshaller
DescribeEnvironmentsResult Unmarshaller
Describe Configuration Settings Request Marshaller
Create Storage Location Request Marshaller
Create Environment Request Marshaller
Response Unmarshaller for CreateApplicationVersion operation
Returns information about the RebuildEnvironment response metadata.
The RebuildEnvironment operation has a void result type.
A list of available AWS Elastic Beanstalk solution stacks.
Adds elements to the SolutionStacks collection
The values to add to the SolutionStacks collection
this instance
Adds elements to the SolutionStacks collection
The values to add to the SolutionStacks collection
this instance
Adds elements to the SolutionStackDetails collection
The values to add to the SolutionStackDetails collection
this instance
Adds elements to the SolutionStackDetails collection
The values to add to the SolutionStackDetails collection
this instance
A list of available solution stacks.
A list of available solution stacks and their SolutionStackDescription.
Container for the parameters to the ListAvailableSolutionStacks operation.
Returns a list of the available solution stack names.
AmazonElasticBeanstalk exception
Constructs a new InvalidParameterCombinationException with the specified error
message.
Describes the error encountered.
Returns information about the CreateEnvironmentResult response and response metadata.
Gets and sets the CreateEnvironmentResult property.
Describes the properties of an environment.
Returns information about the CreateConfigurationTemplateResult response and response metadata.
Gets and sets the CreateConfigurationTemplateResult property.
Describes the settings for a configuration set.
Container for the parameters to the CreateApplication operation.
Creates an application that has one configuration template named default and no application versions.
NOTE: The default configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6
application container.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name of the application. Constraint: This name must be unique within your account. If the specified name already exists, the action
returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
Describes the application.
Constraints:
-
Length
0 - 200
Unmonitor Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if UnmonitorInstancesResult property is set
true if UnmonitorInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the UnmonitorInstancesResult property.
Unmonitor Instances Result
Sets the RouteTableAssociationId property
An identifier representing the association between a route table and
a subnet.
this instance
Checks if RouteTableAssociationId property is set
true if RouteTableAssociationId property is set
Sets the RouteTableId property
The ID of the route table in the association.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the SubnetId property
The ID of the subnet in the association.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the Main property
Whether this is the main route table.
this instance
Checks if Main property is set
true if Main property is set
Gets and sets the RouteTableAssociationId property.
An identifier representing the association between a route table and
a subnet.
Gets and sets the RouteTableId property.
The ID of the route table in the association.
Gets and sets the SubnetId property.
The ID of the subnet in the association.
Gets and sets the Main property.
Whether this is the main route table.
Revoke Security GroupIngress Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Purchase Reserved Instances Offering Result
Checks if ReservedInstancesId property is set
true if ReservedInstancesId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ReservedInstancesId property.
The IDs of the purchased Reserved Instances.
Purchases a Reserved Instance for use with your
account. With Amazon
EC2 Reserved Instances, you purchase the right
to launch Amazon EC2
instances for a period of time (without
getting insufficient capacity errors)
and pay a lower usage rate for
the actual time used. For more information
about Reserved Instances,
go to the Amazon Elastic Compute Cloud
Developer Guide.
Sets the ReservedInstancesOfferingId property
The offering ID of the Reserved Instance to
purchase.
this instance
Checks if ReservedInstancesOfferingId property is set
true if ReservedInstancesOfferingId property is set
Sets the InstanceCount property
The number of Reserved Instances to purchase.
Default: 1
this instance
Checks if InstanceCount property is set
true if InstanceCount property is set
Gets and sets the ReservedInstancesOfferingId property.
The offering ID of the Reserved Instance to
purchase.
Gets and sets the InstanceCount property.
The number of Reserved Instances to purchase.
Default: 1
Monitor Instances Result
Checks if InstanceMonitoring property is set
true if InstanceMonitoring property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the InstanceMonitoring property.
Instance monitoring information
Information about the instance block device
mapping set.
Sets the DeviceName property
The device name (e.g., /dev/sdh).
this instance
Checks if DeviceName property is set
true if DeviceName property is set
Sets the Ebs property
Ebs property
this instance
Checks if Ebs property is set
true if Ebs property is set
Gets and sets the DeviceName property.
The device name (e.g., /dev/sdh).
Gets and sets the Ebs property.
The Response for the
ImportKeyPair operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ImportKeyPairResult property is set
true if ImportKeyPairResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ImportKeyPairResult property.
ImportKeyPair Result
Imports the public key from an RSA key pair created with a third-party tool.
This operation differs from CreateKeyPair as the private key is never
transferred between the caller and AWS servers.
RSA key pairs are easily created on Microsoft Windows and Linux OS systems using
the ssh-keygen command line tool provided with the standard OpenSSH
installation. Standard library support for RSA key pair creation is also available
for Java, Ruby, Python, and many other programming languages.
The following formats are supported:
- OpenSSH public key format,
- Base64 encoded DER format.
- SSH public key file format as specified in
RFC4716.
Sets the KeyName property
The unique name for the key pair.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the PublicKeyMaterial property
The public key. This key must be base64 encoded before calling
this operation.
this instance
Checks if PublicKeyMaterial property is set
true if PublicKeyMaterial property is set
Gets and sets the KeyName property.
The unique name for the key pair.
Gets and sets the PublicKeyMaterial property.
The public key. This key must be base64 encoded before calling
this operation.
Constants for the possible virtualization type.
HVM (Hardware Virtual Machine) based virtualization is a type of full virtualization enabled through native
hardware platform support for virtualization.
PVM (Para-Virtual Machine) based virtualization does not have direct access to the hardware.
Constants for the strategy of a placement group.
The instance types possible by EC2.
The Response for the
DetachInternetGateway operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Describe Vpn Connections Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeVpnConnectionsResult property is set
true if DescribeVpnConnectionsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeVpnConnectionsResult property.
Describe Vpn Connections Result
Describe VPCs Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeVpcsResult property is set
true if DescribeVpcsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeVpcsResult property.
Describe Vpcs Result
DescribeKeyPairsResponse
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeKeyPairsResult property is set
true if DescribeKeyPairsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeKeyPairsResult property.
Describe Key Pairs Result
Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint
for your VPN connection. You can create a VPN gateway before
creating the VPC itself. AWS might delete any VPN
gateway that you create with this operation if you leave
it inactive for an extended period of time (inactive means that
there's no VPN connection in use with the VPN gateway)
Sets the Type property
The type of VPN connection this VPN gateway
supports. Valid
Values: ipsec.1
this instance
Checks if Type property is set
true if Type property is set
Sets the AvailabilityZone property
The Availability Zone where you want the VPN
gateway.
Default: AWS selects a zone for you (recommended)
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Gets and sets the Type property.
The type of VPN connection this VPN gateway
supports. Valid
Values: ipsec.1
Gets and sets the AvailabilityZone property.
The Availability Zone where you want the VPN
gateway.
Default: AWS selects a zone for you (recommended)
Create Spot Datafeed Result
Checks if SpotDatafeedSubscription property is set
true if SpotDatafeedSubscription property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SpotDatafeedSubscription property.
Describes the Spot Datafeed subscription.
Create Snapshot Response
Checks if CreateSnapshotResult property is set
true if CreateSnapshotResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CreateSnapshotResult property.
Create Snapshot Result
Gets and sets the ResponseMetadata property.
Response Metadata
Create Security Group Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateSecurityGroupResult property is set
true if CreateSecurityGroupResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateSecurityGroupResult property.
CreateSecurityGroup Result
Creates a new network ACL in a VPC. Network ACLs provide an optional layer of security (on top of
security groups) for the instances in your VPC. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Sets the VpcId property
The ID of the VPC where the network ACL will be created.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the VpcId property.
The ID of the VPC where the network ACL will be created.
Creates a new 2048-bit RSA key pair with the specified name. The public
key is stored by Amazon EC2 and the private key is displayed on the console.
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.
Sets the KeyName property
A unique name for the key pair.
Constraints:
Accepts alphanumeric characters, spaces, dashes, and underscores.
this instance
Checks if KeyName property is set
true if KeyName property is set
Gets and sets the KeyName property.
A unique name for the key pair.
Constraints:
Accepts alphanumeric characters, spaces, dashes, and underscores.
Request to cancel existing Spot Instance
requests.
Sets the SpotInstanceRequestId property
The list of Spot Instance requests that you
want to cancel.
this instance
Checks if SpotInstanceRequestId property is set
true if SpotInstanceRequestId property is set
Gets and sets the SpotInstanceRequestId property.
The list of Spot Instance requests that you
want to cancel.
The Response for the
AttachInternetGateway operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
AssociateRouteTable Result
Checks if AssociationId property is set
true if AssociationId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the AssociationId property.
ID that AWS provides to represent the association of the route table
and the subnet.
Associate Dhcp Options Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
MetricAlarm Unmarshaller
GetMetricStatisticsResult Unmarshaller
Response Unmarshaller for EnableAlarmActions operation
The StatisticSet data type describes the
StatisticValues component of MetricDatum, and represents a set
of statistics that describes a specific metric.
Sets the SampleCount property
The value to set for the SampleCount property
this instance
Sets the Sum property
The value to set for the Sum property
this instance
Sets the Minimum property
The value to set for the Minimum property
this instance
Sets the Maximum property
The value to set for the Maximum property
this instance
The number of samples used for the statistic set.
The sum of values for the sample set.
The minimum value of the sample set.
The maximum value of the sample set.
Returns information about the PutMetricAlarm response metadata.
The PutMetricAlarm operation has a void result type.
The Dimension data type further expands on the identity
of a metric using a Name, Value pair.
Sets the Name property
The value to set for the Name property
this instance
Sets the Value property
The value to set for the Value property
this instance
The name of the dimension.
Constraints:
-
Length
1 - 255
The value representing the dimension measurement
Constraints:
-
Length
1 - 255
Implemenation for accessing AmazonCloudWatch.
Amazon CloudWatch Amazon CloudWatch is a web service that
enables you to monitor and manage various metrics, as well as
configure alarm actions based on data from metrics.
Amazon CloudWatch monitoring enables you to collect, analyze,
and view system and application metrics so that you can make
operational and business decisions more quickly and with greater
confidence. You can use Amazon CloudWatch to collect metrics about
your AWS resources, such as the performance of your Amazon EC2
instances. You can also publish your own metrics directly to Amazon
CloudWatch. Amazon CloudWatch allows you to manage the
metrics in several ways. If you are publishing your own metrics, you
can define custom metrics for your own use. If you are registered for
an AWS product that supports Amazon CloudWatch, the service
automatically pushes basic metrics to CloudWatch for you. Once Amazon
CloudWatch contains metrics from either source, you can calculate
statistics based on that data and graphically visualize those
statistics in the Amazon CloudWatch Console. Amazon
CloudWatch alarms help you implement decisions more easily by enabling
you to do things like send notifications or automatically make changes
to the resources you are monitoring, based on rules that you define.
For example, you can create alarms that initiate Auto Scaling and
Simple Notification Service actions on your behalf.
Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonCloudWatchClient Configuration Object
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. When this operation creates an alarm,
the alarm state is immediately set to INSUFFICIENT_DATA . The
alarm is evaluated and its StateValue is set appropriately.
Any actions associated with the StateValue is then executed.
NOTE: When updating an existing alarm, its
StateValue is left unchanged.
Container for the necessary
parameters to execute the PutMetricAlarm service method on
AmazonCloudWatch.
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. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action. The size of
a PutMetricData request is limited to 8 KB for HTTP GET requests and
40 KB for HTTP POST requests. IMPORTANT: Although
the Value parameter accepts numbers of type Double, Amazon CloudWatch
truncates values with very large exponents. Values with base-10
exponents greater than 126 (1 x 10^126) are truncated. Likewise,
values with base-10 exponents less than -130 (1 x 10^-130) are also
truncated.
Container for the necessary
parameters to execute the PutMetricData service method on
AmazonCloudWatch.
Returns a list of valid metrics stored for the AWS account
owner. Returned metrics can be used with GetMetricStatistics to
obtain statistical data for a given metric. NOTE:
Up to 500 results are returned for any one call. To retrieve further
results, use returned NextToken values with subsequent ListMetrics
operations. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action.
Container for the necessary
parameters to execute the ListMetrics service method on
AmazonCloudWatch.
The response from the ListMetrics service method, as returned
by AmazonCloudWatch.
Gets statistics for the specified metric.
NOTE: The maximum number of data points returned from a
single GetMetricStatistics request is 1,440. If a request is made that
generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified
time range or increasing the specified period. Alternatively, make
multiple requests across adjacent time ranges. Amazon
CloudWatch aggregates data points based on the length of the
period 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. NOTE: The maximum number of data
points that can be queried is 50,850; whereas the maximum number of
data points returned is 1,440. The following examples
show various statistics allowed by the data point query maximum of
50,850 when you call GetMetricStatistics on Amazon EC2
instances with detailed (one-minute) monitoring enabled:
- Statistics for up to 400 instances for a span of one hour
- Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
Container for the necessary
parameters to execute the GetMetricStatistics service method on
AmazonCloudWatch.
The response from the GetMetricStatistics service method, as
returned by AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DisableAlarmActions service method on
AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DescribeAlarms service method on
AmazonCloudWatch.
The response from the DescribeAlarms service method, as
returned by AmazonCloudWatch.
Retrieves all alarms for a single metric. Specify a statistic,
period, or unit to filter the set of alarms further.
Container for the
necessary parameters to execute the DescribeAlarmsForMetric service
method on AmazonCloudWatch.
The response from the DescribeAlarmsForMetric service method,
as returned by AmazonCloudWatch.
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.
Container for the necessary
parameters to execute the DescribeAlarmHistory service method on
AmazonCloudWatch.
The response from the DescribeAlarmHistory service method, as
returned by AmazonCloudWatch.
Enables actions for the specified alarms.
Container for the necessary
parameters to execute the EnableAlarmActions service method on
AmazonCloudWatch.
Deletes all specified alarms. In the event of an error, no
alarms are deleted.
Container for the necessary
parameters to execute the DeleteAlarms service method on
AmazonCloudWatch.
Temporarily sets the state of an alarm. When the updated
StateValue differs from the previous value, the action
configured for the appropriate state is invoked. This is not a
permanent change. The next periodic alarm check (in about a minute)
will set the alarm to its actual state.
Container for the necessary
parameters to execute the SetAlarmState service method on
AmazonCloudWatch.
The SetDistributionConfigRequest contains the parameters used for the
SetDistributionConfig operation.
The ETag parameter is used if you wish to specify the ETag to match with the
ETag of the Distribution with the Id specified.
Required Parameters: Id
Required Parameters: DistributionConfig
Required Parameters: ETag of the Distribution. This
can be retrieved via a call to GetDistibutionInfo
If you want to serve private content, you need to:
- Associate an Origin Access Identity with the DistributionConfig
- Associate TrustedSigners with the DistributionConfig if you want to
serve content via Signed URLs
Sets the Id property for this request.
This is the CloudFront Distribution Id that will be reconfigured
by this request.
The value that Id is set to
the request with the Id set
Sets the DistributionConfig property for this request.
The value that DistributionConfig is set to
the request with the Configuration set
Sets the ETag property for this request.
This is the ETag of the CloudFront Distribution which will be reconfigured.
The value that ETag is set to
the request with the ETag set
Gets and sets the Id property.
Gets and Sets the DistributionConfig property.
The CloudFront Distribution's configuration will be modified
to reflect the values in this configuration object.
Gets and sets the ETag property. This should be the ETag of the Distribution.
Contains a list of paths to objects that are to be invalidated and a CallerReference to ensure the request can't be replayed.
For more information, please visit:
Default constructor
Constructs and instance of InvalidationBatch with a callerReference.
A unique name that ensures the request can't be replayed.
Constructs and instance of InvalidationBatch with a callerReference and a list of paths to objects.
A unique name that ensures the request can't be replayed.
A list of paths to objects that will be invalidated.
Sets the CallerReference property and returns back this instance to chain method calls.
A unique name that ensures the request can't be replayed.
This instance
Adds paths to the collection of path strings and returns back this instance to chain method calls.
A list of paths to objects that will be invalidated
This instance
Adds paths to the collection of path strings and returns back this instance to chain method calls.
A list of paths to objects that will be invalidated
This instance
Creates a XML representation of this object and returns it back as a string.
A XML string representing this object.
Gets and Sets the CallerReference property a unique name that ensures the request can't be replayed.
Gets and Sets the Paths property which is a list of paths to objects that will be invalidated.
The GetInvalidationRequest contains the parameters used for the GetInvalidation operation.
Required Parameter: DistributionId, InvalidationId
Sets the InvalidationId property of this request to the value passed in.
The invalidation's id
The request with the InvalidationId property set
Sets the DistributionId property of this request to the value passed in.
The distribution's id
The request with the DistributionId property set
Sets the DistributionId property of this request to the value passed in.
The distribution's id
The request with the DistributionId property set
Gets and Sets the InvalidationId property for the invalidation
Gets and Sets the DistributionId property for the Distribution
The GetInvalidationListRequest contains the parameters used for the GetInvalidationList operation.
Required Parameter: DistributionId
Sets the Marker property for this request.
All keys returned will be lexiographically after the marker.
the value that Marker is set to
this instance
Sets the MaxItems property for this request.
Limits the result set of keys to MaxItems.
the value that MaxItems is set to
this instance
Sets the DistributionId property of this request to the value passed in.
The distribution's id
The request with the DistributionId property set
Gets and sets the Marker property.
All keys returned will be lexiographically after the marker.
Gets and sets the MaxItems property.
Limits the result set of keys to MaxItems.
Gets and Sets the DistributionId property for the Distribution
The DeleteStreamingDistributionResponse contains any headers returned by CloudFront.
List Stacks Result
Adds elements to the StackSummaries collection
The values to add to the StackSummaries collection
this instance
Adds elements to the StackSummaries collection
The values to add to the StackSummaries collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Returns information about the ListStacksResult response and response metadata.
Gets and sets the ListStacksResult property.
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.
Sets the StackName property
The value to set for the StackName property
this instance
The name or the unique identifier associated with the stack. Default: There is no default value.
Response Unmarshaller for DescribeScheduledActions operation
Response Unmarshaller for DescribeScalingProcessTypes operation
Response Unmarshaller for DescribeAutoScalingNotificationTypes operation
Describe Adjustment Types Request Marshaller
Returns information about the SetDesiredCapacity response metadata.
The SetDesiredCapacity operation has a void result type.
Returns information about the PutScheduledUpdateGroupAction response metadata.
The PutScheduledUpdateGroupAction operation has a void result type.
The PolicyARNType data type.
Sets the PolicyARN property
The value to set for the PolicyARN property
this instance
A policy's Amazon Resource Name (ARN).
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Ebs data type.
Sets the SnapshotId property
The value to set for the SnapshotId property
this instance
Sets the VolumeSize property
The value to set for the VolumeSize property
this instance
The Snapshot ID.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The volume size, in GigaBytes.
Constraints:
-
Range
1 - 1024
Returns information about the DescribeScalingProcessTypesResult response and response metadata.
Gets and sets the DescribeScalingProcessTypesResult property.
The output of the DescribeScalingProcessTypes action.
The output of the DescribeAdjustmentTypes action.
Adds elements to the AdjustmentTypes collection
The values to add to the AdjustmentTypes collection
this instance
Adds elements to the AdjustmentTypes collection
The values to add to the AdjustmentTypes collection
this instance
A list of specific policy adjustment types.
A Scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the
group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API.
Sets the ActivityId property
The value to set for the ActivityId property
this instance
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the Cause property
The value to set for the Cause property
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the EndTime property
The value to set for the EndTime property
this instance
Sets the StatusCode property
The value to set for the StatusCode property
this instance
Sets the StatusMessage property
The value to set for the StatusMessage property
this instance
Sets the Progress property
The value to set for the Progress property
this instance
Specifies the ID of the activity.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Contains a friendly, more verbose description of the scaling activity.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Contains the reason the activity was begun.
Constraints:
-
Length
1 - 1023
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Provides the start time of this activity.
Provides the end time of this activity.
Contains the current status of the activity.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Contains a friendly, more verbose description of the activity status.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies a value between 0 and 100 that indicates the progress of the activity.
The Amazon Web Services SDK provides devlopers with a coherent and unified interface to the
suite of Amazon Web Services. The intent is to facilitate the rapid building of
applications that leverage multiple Amazon Web Services.
To get started, request an instance of the AWSClientFactory via this class's static Instance
member. Use the factory instance to create clients for all the Web Services needed by
the application.
Create a client for the Amazon EC2 Service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon EC2 client
Create a client for the Amazon EC2 Service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon EC2 client
Create a client for the Amazon SimpleDB Service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon SimpleDB client
Create a client for the Amazon SimpleDB Service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon SimpleDB client
Create a client for the Amazon ElasticMapReduce service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon ElasticMaReduce client
Create a client for the Amazon ElasticMapReduce service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon ElasticMapReduce client
Create a client for the Amazon SQS service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon SQS client
Create a client for the Amazon SQS service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon SQS client
Create a client for the Amazon CloudWatch service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon CloudWatch client
Create a client for the Amazon CloudWatch service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon SQS client
Create a client for the Amazon Elastic Load Balancing service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon Elastic Load Balancing client
Create a client for the Amazon Elastic Load Balancing service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon Elastic Load Balancing client
Create a client for the Amazon Auto Scaling service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon Auto Scaling client
Create a client for the Amazon Auto Scaling service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon Auto Scaling client
Create a client for the Amazon S3 service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon S3 client
Create a client for the Amazon S3 service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon S3 client
Create a client for the Amazon RDS service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon RDS client
Create a client for the Amazon RDS service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon RDS client
Create a client for the Amazon CloudFront service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon CloudFront client
Create a client for the Amazon CloudFront service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon CloudFront client
Create a client for the Amazon SNS service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon SNS client
Create a client for the Amazon SNS service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon SNS client
Create a client for the Amazon Identity Management service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon Identity Management client
Create a client for the Amazon Identity Management service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service
An Amazon Identity Management client
Create a client for the Amazon ElasticBeanstalk Service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon ElasticBeanstalk client
Create a client for the Amazon ElasticBeanstalk Service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon ElasticBeanstalk client
Create a client for the Amazon Simple Email Service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon Simple Email Service client
Create a client for the Amazon Simple Email Service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service
An Amazon Simple Email Service client
Create a client for the Amazon CloudFormation Service with the default configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
An Amazon CloudFormation client
Create a client for the Amazon CloudFormation Service with the specified configuration
The AWS Access Key associated with the account
The AWS Secret Access Key associated with the account
Configuration options for the service like HTTP Proxy, # of connections, etc
An Amazon CloudFormation client
The DeleteQueue action deletes the queue specified by the queue URL, regardless of whether the queue is empty.
If the specified queue does not exist, SQS returns a successful response. Use DeleteQueue with care; once you
delete your queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue
during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds,
the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds
before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
Returns information about the created queue, including queue URL and request metadata.
Checks if CreateQueueResult property is set
true if CreateQueueResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CreateQueueResult property.
Information returned by the CreateQueueRequest, including queue URL.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
A wrapper type for the attributes of an SNS subscription.
Sets the SubscriptionArn property
The subscription's ARN.
this instance
Checks if SubscriptionArn property is set
true if SubscriptionArn property is set
Sets the Owner property
The subscription's owner.
this instance
Checks if Owner property is set
true if Owner property is set
Sets the Protocol property
The subscription's protocol.
this instance
Checks if Protocol property is set
true if Protocol property is set
Sets the Endpoint property
The subscription's endpoint (format depends on the protocol).
this instance
Checks if Endpoint property is set
true if Endpoint property is set
Sets the TopicArn property
The ARN of the subscription's topic.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Gets and sets the SubscriptionArn property.
The subscription's ARN.
Gets and sets the Owner property.
The subscription's owner.
Gets and sets the Protocol property.
The subscription's protocol.
Gets and sets the Endpoint property.
The subscription's endpoint (format depends on the protocol).
Gets and sets the TopicArn property.
The ARN of the subscription's topic.
Encapsulates the metadata and result of the CreateTopic action.
Checks if CreateTopicResult property is set
true if CreateTopicResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CreateTopicResult property.
Encapsulates the result of the CreateTopic action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
SendRawEmailResult Unmarshaller
GetSendQuotaResult Unmarshaller
Container for the parameters to the GetSendQuota operation.
Returns the user's current activity limits.
Returns information about the DeleteVerifiedEmailAddress response metadata.
The DeleteVerifiedEmailAddress operation has a void result type.
Interface for accessing AmazonSimpleEmailService.
Amazon Simple Email Service This is the API Reference for
Amazon Simple Email Service (Amazon SES). This documentation is
intended to be used in conjunction with the Amazon SES Getting Started
Guide and the Amazon SES Developer Guide. For specific
details on how to construct a service request, please consult the
Amazon SES Developer Guide.
Returns the user's current activity limits.
Container for the necessary
parameters to execute the GetSendQuota service method on
AmazonSimpleEmailService.
The response from the GetSendQuota service method, as
returned by AmazonSimpleEmailService.
Returns a list containing all of the email addresses that have
been verified.
Container for the
necessary parameters to execute the ListVerifiedEmailAddresses service
method on AmazonSimpleEmailService.
The response from the ListVerifiedEmailAddresses service
method, as returned by AmazonSimpleEmailService.
Returns the user's sending statistics. The result is a list of
data points, representing the last two weeks of sending
activity. Each data point in the list contains statistics
for a 15-minute interval.
Container for the necessary
parameters to execute the GetSendStatistics service method on
AmazonSimpleEmailService.
The response from the GetSendStatistics service method, as
returned by AmazonSimpleEmailService.
Composes an email message, based on input data, and then
immediately queues the message for sending.
Container for the necessary parameters
to execute the SendEmail service method on
AmazonSimpleEmailService.
The response from the SendEmail service method, as returned
by AmazonSimpleEmailService.
Deletes the specified email address from the list of verified
addresses.
Container for the
necessary parameters to execute the DeleteVerifiedEmailAddress service
method on AmazonSimpleEmailService.
Verifies an email address. This action causes a confirmation
email message to be sent to the specified address.
Container for the necessary
parameters to execute the VerifyEmailAddress service method on
AmazonSimpleEmailService.
Sends an email message, with header and content specified by the
client. The SendRawEmail action is useful for sending multipart
MIME emails, with attachments or inline content. The raw
text of the message must comply with Internet email standards;
otherwise, the message cannot be sent. For more information, go to
the Amazon SES Developer Guide.
Container for the necessary
parameters to execute the SendRawEmail service method on
AmazonSimpleEmailService.
The response from the SendRawEmail service method, as
returned by AmazonSimpleEmailService.
The ListObjectsResponse contains the list of S3Objects in the bucket and
any headers returned by S3.
Gets and sets the Name property.
The bucket's name.
Gets and sets the Prefix property.
Keys that begin with the indicated prefix are listed.
Gets the S3Objects property. This is a list of
objects in the bucket that match your search criteria.
Gets and sets the NextMarker property.
NextMarker is set by S3 only if a Delimiter was specified
in the original ListObjects request. If a delimiter was
not specified, the AWS SDK for .NET returns the last Key
of the List of Objects retrieved from S3 as the NextMarker.
Gets and sets the MaxKeys property.
This is the maximum number of keys in the S3Objects collection.
The value is derived from the MaxKeys parameter to ListObjectsRequest.
Gets and sets the Delimiter property.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
Gets the CommonPrefixes property.
A response can contain CommonPrefixes only if you specify a delimiter.
When you do, CommonPrefixes contains all (if there are any) keys between
Prefix and the next occurrence of the string specified by delimiter. In effect,
CommonPrefixes lists keys that act like subdirectories in the directory specified
by Prefix. For example, if prefix is notes/ and delimiter is a slash (/), in
notes/summer/july, the common prefix is notes/summer/.
Returns the list of common prefixes returned by S3.
This property has been deprecated. Please use the
CommonPrefixes property instead.
Gets and Sets the IsTruncated property.
This property governs whether
this is the last set of items that match the
specified criteria or whether you need to make
another call to S3 to retrieve more keys.
The GetObjectResponse contains any header or metadata returned by S3.
GetObjectResponse's contain resources that need to be disposed. The
recommended way for handling GetObjectResponse objects is wrapping them
in using clauses, like so:
using (GetObjectResponse response = s3Client.GetObject(request))
{
...
}
This will ensure that any network resources, file streams and web headers
have been returned back to the system for future use.
Writes the content of the ResponseStream a file indicated by the filePath argument.
The location where to write the ResponseStream
The "handler" will be notified every time a put
object progress event is raised.
A method that consumes the put object progress notification
this instance of the PutObjectRequest
This method is called by a producer of write object progress
notifications. When called, all the subscribers in the
invocation list will be called sequentially.
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the ETag property.
Gets and sets the ContentType property.
Gets and sets the ContentLength property.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
The event for Write Object progress notifications. All
subscribers will be notified when a new progress
event is raised.
Subscribe to this event if you want to receive
put object progress notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, WriteObjectProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the Put Object Progress Event delegate's invocation list
GetObjectResponse response = s3Client.GetObject(request);
response.WriteObjectProgressEvent += displayProgress;
Encapsulates the information needed to provide
download progress for the Write Object Event.
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
The bucket name for the S3 object being written.
The object key for the S3 object being written.
The version-id of the S3 object.
The number of bytes transferred since last event
The number of bytes transferred
The total number of bytes to be transferred
Gets the bucket name for the S3 object being written.
Gets the object key for the S3 object being written.
Gets the version-id of the S3 object.
The SetBucketVersioningResponse contains the headers and request specific information
returned by S3
This class contains the values of the response headers that will be set on the
response from a GetObject request. These values override any headers that were set
when the object was uploaded to S3.
Sets the ContentType property and returns back this instance for method chaining.
The content type for the returned object.
this instance
Sets the ContentLanguage property and returns back this instance for method chaining.
The content language for the returned object.
this instance
Sets the Expires property and returns back this instance for method chaining.
The expires for the returned object.
this instance
Sets the CacheControl property and returns back this instance for method chaining.
The cache control for the returned object.
this instance
Sets the ContentDisposition property and returns back this instance for method chaining.
The content disposition for the returned object.
this instance
Sets the ContentEncoding property and returns back this instance for method chaining.
The content encoding for the returned object.
this instance
Gets or sets the ContentType.
Gets or sets the ContentLanguage.
Gets or sets the Expires.
Gets or sets the CacheControl.
Gets or sets the ContentDisposition.
Gets or sets the ContentEncoding.
Container for elements related to a particular multipart upload.
Gets and sets the Key of the object for which the multipart upload was initiated.
Gets and sets the Upload ID that identifies the multipart upload.
Gets and sets the Owner property.
Gets and sets the Initiator property.
Gets and sets the class of storage that will be used to store the object when multipart
upload is complete.
Gets and sets the date and time at which the multipart upload was initiated.
The GetBucketPolicyRequest contains the parameters used for the GetBucketPolicy operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
Information about the request.
Sets the RequestId property
ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence.
this instance
Gets and sets the RequestId property.
ID that uniquely identifies a request. Amazon keeps track of request IDs. If you have a question about a request, include the request ID in your correspondence.
Utilities for converting objects to strings. Used by the marshaller classes.
Describe Reserved D B Instances Request Marshaller
Describe Events Request Marshaller
DBSnapshot Unmarshaller
Create D B Parameter Group Request Marshaller
The results from the RevokeDBSecurityGroupIngress action.
Gets and sets the RevokeDBSecurityGroupIngressResult property.
Contains the result of a successful invocation of the RevokeDBSecurityGroupIngress
action.
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions. This
data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Sets the ParameterName property
The value to set for the ParameterName property
this instance
Sets the ParameterValue property
The value to set for the ParameterValue property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the Source property
The value to set for the Source property
this instance
Sets the ApplyType property
The value to set for the ApplyType property
this instance
Sets the DataType property
The value to set for the DataType property
this instance
Sets the AllowedValues property
The value to set for the AllowedValues property
this instance
Sets the IsModifiable property
The value to set for the IsModifiable property
this instance
Sets the MinimumEngineVersion property
The value to set for the MinimumEngineVersion property
this instance
Sets the ApplyMethod property
The value to set for the ApplyMethod property
this instance
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational
implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
Constraints:
-
Allowed Values
immediate, pending-reboot
AmazonRDS exception
Constructs a new InvalidDBSnapshotStateException with the specified error
message.
Describes the error encountered.
AmazonRDS exception
Constructs a new DBSnapshotNotFoundException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the CreateDBParameterGroup action. This data type is used as a
request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the Description property
The value to set for the Description property
this instance
Provides the name of the DB Parameter Group.
Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.
Provides the customer-specified description for this DB Parameter Group.
Container for the parameters to the CreateDBInstance operation.
Creates a new DB instance.
Sets the DBName property
The value to set for the DBName property
this instance
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the AllocatedStorage property
The value to set for the AllocatedStorage property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Engine property
The value to set for the Engine property
this instance
Sets the MasterUsername property
The value to set for the MasterUsername property
this instance
Sets the MasterUserPassword property
The value to set for the MasterUserPassword property
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the PreferredMaintenanceWindow property
The value to set for the PreferredMaintenanceWindow property
this instance
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the BackupRetentionPeriod property
The value to set for the BackupRetentionPeriod property
this instance
Sets the PreferredBackupWindow property
The value to set for the PreferredBackupWindow property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB
Instance is created. If this parameter is not specified, no database is created in the DB Instance. Constraints: - Must contain 1 to
64 alphanumeric characters
- Cannot be a word reserved by the specified database engine
Type: String Oracle The
Oracle System ID (SID) of the created DB Instance. Default: ORACL Constraints: - Cannot be longer than 8 characters
The DB Instance identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 alphanumeric
characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The amount of storage (in gigabytes) to be initially allocated for the database instance. MySQL Constraints: Must be an integer from
5 to 1024. Type: Integer Oracle Constraints: Must be an integer from 10 to 1024.
The compute and memory capacity of the DB Instance. Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge
| db.m2.4xlarge
The name of the database engine to be used for this instance. Valid Values: MySQL | oracle-se1 | oracle-se |
oracle-ee
The name of master user for the client DB Instance. MySQL Constraints: - Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle Constraints: - Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a
reserved word for the chosen database engine.
The password for the master DB Instance user. MySQL Constraints: Cannot contain more than 41 alphanumeric characters. Type: String
Oracle Constraints: Cannot contain more than 30 alphanumeric characters.
A list of DB Security Groups to associate with this DB Instance. Default: The default DB Security Group for the database engine.
The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone in the
endpoint's region. Example: us-east-1d Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set
to true. The specified Availability Zone must be in the same region as the current endpoint.
The weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window
selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks
for each region from which the default maintenance windows are assigned. - US-East (Northern Virginia) Region: 03:00-11:00
UTC
- US-West (Northern California) Region: 06:00-14:00 UTC
- EU (Ireland) Region: 22:00-06:00 UTC
- Asia Pacific (Singapore) Region: 14:00-22:00 UTC
- Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
Valid
Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
The name of the database parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for
the specified engine will be used. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a
letter
- Cannot end with a hyphen or contain two consecutive hyphens
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this
parameter to 0 disables automated backups. Default: 1 Constraints: - Must be a value from 0 to 8
- Cannot be set to 0 if the
DB Instance is a master instance with read replicas
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks
for each region from which the default backup windows are assigned. - US-East (Northern Virginia) Region: 03:00-11:00 UTC
- US-West (Northern California) Region: 06:00-14:00 UTC
- EU (Ireland) Region: 22:00-06:00 UTC
- Asia
Pacific (Singapore) Region: 14:00-22:00 UTC
- Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
Constraints: Must
be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
The port number on which the database accepts connections. MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer
Oracle Default: 1521 Valid Values: 1150-65535
Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to
true.
The version number of the database engine to use. MySQL Example: 5.1.42 Type: String Oracle Example: 11.2.0.2.v2
Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window. Default: true
License model information for this DB Instance. Valid values: license-included | bring-your-own-license |
general-public-license
Returns information about the AuthorizeDBSecurityGroupIngress response and response metadata.
Gets and sets the AuthorizeDBSecurityGroupIngressResult property.
Contains the result of a successful invocation of the AuthorizeDBSecurityGroupIngress
action.
ListJobsResult Unmarshaller
Upload Server Certificate Request Marshaller
Update User Request Marshaller
Response Unmarshaller for UpdateSigningCertificate operation
Update Group Request Marshaller
Response Unmarshaller for ResyncMFADevice operation
List Signing Certificates Request Marshaller
Response Unmarshaller for ListGroups operation
List Groups Request Marshaller
GetGroupResult Unmarshaller
Returns information about the ListGroupsForUserResult response and response metadata.
Gets and sets the ListGroupsForUserResult property.
Contains the result of a successful invocation of the ListGroupsForUser action.
Contains the result of a successful invocation of the
ListAccessKeys action.
Adds elements to the AccessKeyMetadata collection
The values to add to the AccessKeyMetadata collection
this instance
Adds elements to the AccessKeyMetadata collection
The values to add to the AccessKeyMetadata collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of access key metadata.
A flag that indicates whether there are more keys to list. If your results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more keys in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
AmazonIdentityManagementService exception
Constructs a new InvalidCertificateException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the
GetAccountSummary action.
Adds the KeyValuePairs to the SummaryMap dictionary.
The pairs to be added to the SummaryMap dictionary.
this instance
A set of key value pairs containing account-level information. SummaryMap contains the following keys: - Users - Number
of Users for the AWS Account
- UsersQuota - Maximum Users allowed for the AWS Account
- Groups - Number of
Groups for the AWS Account
- GroupsQuota - Maximum Groups allowed for the AWS Account
- ServerCertificates -
Number of Server Certificates for the AWS Account
- ServerCertificatesQuota - Maximum Server Certificates allowed for the AWS
Account
- UserPolicySizeQuota - Maximum allowed size for User policy documents (in kilobytes)
- GroupPolicySizeQuota - Maximum allowed size for Group policy documents (in kilobyes)
- GroupsPerUserQuota - Maximum
number of groups a User can belong to
- SigningCertificatesPerUserQuota - Maximum number of X509 certificates allowed for a
user
- AccessKeysPerUserQuota - Maximum number of access keys that can be created per User
Configuration for accessing AWS Identity and Access Management service
Default constructor
Gets the ServiceVersion property.
ScriptBootstrapActionConfig Unmarshaller
RunJobFlowResult Unmarshaller
Response Unmarshaller for RunJobFlow operation
KeyValue Unmarshaller
Configuration of the script to run during a bootstrap
action.
Sets the Path property
The value to set for the Path property
this instance
Adds elements to the Args collection
The values to add to the Args collection
this instance
Location of the script to run during a bootstrap action. Can be either
a location in Amazon S3 or on a local file system.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of command line arguments to pass to the bootstrap action
script.
Container for the parameters to the ModifyInstanceGroups operation.
ModifyInstanceGroups modifies the number of nodes and
configuration settings of an instance group. The input parameters
include the new target instance count for the group and the instance
group ID. The call will either succeed or fail atomically.
Adds elements to the InstanceGroups collection
The values to add to the InstanceGroups collection
this instance
Instance groups to change.
Configuration for accessing service
Default constructor
Gets the ServiceVersion property.
DescribeLoadBalancersResult Unmarshaller
Create Load Balancer Listeners Request Marshaller
CreateAppCookieStickinessPolicyResult Unmarshaller
Returns information about the SetLoadBalancerPoliciesOfListenerResult response and response metadata.
Gets and sets the SetLoadBalancerPoliciesOfListenerResult property.
The output for the SetLoadBalancerPoliciesOfListener action.
The output for the SetLoadBalancerListenerSSLCertificate action.
Returns information about the RegisterInstancesWithLoadBalancerResult response and response metadata.
Gets and sets the RegisterInstancesWithLoadBalancerResult property.
The output for the RegisterInstancesWithLoadBalancer action.
Container for the parameters to the RegisterInstancesWithLoadBalancer operation.
Adds new instances to the LoadBalancer. Once the instance is registered, it starts receiving traffic and requests from
the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the
OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same
account credentials as those that were used to create the LoadBalancer. NOTE: Completion of this API does not guarantee
that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.
Default constructor for a new RegisterInstancesWithLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new RegisterInstancesWithLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of instances IDs that should be registered with the LoadBalancer.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of instances IDs that should be registered with the LoadBalancer.
AmazonElasticLoadBalancing exception
Constructs a new PolicyNotFoundException with the specified error
message.
Describes the error encountered.
The LBCookieStickinessPolicy data type.
Default constructor for a new LBCookieStickinessPolicy object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new LBCookieStickinessPolicy object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name for the policy being created. The name must be unique within the set of policies for this LoadBalancer.
The time period in seconds after which the cookie should be considered stale. Not specifying this
parameter indicates that the sticky session will last for the duration of the browser session.
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the CookieExpirationPeriod property
The value to set for the CookieExpirationPeriod property
this instance
The name for the policy being created. The name must be unique within the set of policies for this LoadBalancer.
The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky
session will last for the duration of the browser session.
The output for the EnableAvailabilityZonesForLoadBalancer action.
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
An updated list of Availability Zones for the LoadBalancer.
Container for the parameters to the DeleteLoadBalancerPolicy operation.
Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.
Default constructor for a new DeleteLoadBalancerPolicyRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DeleteLoadBalancerPolicyRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.
The mnemonic name for the policy being deleted.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.
The mnemonic name for the policy being deleted.
Container for the parameters to the DeleteLoadBalancerListeners operation.
Deletes listeners from the LoadBalancer for the specified port.
Default constructor for a new DeleteLoadBalancerListenersRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DeleteLoadBalancerListenersRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The mnemonic name associated with the LoadBalancer.
The client port number(s) of the LoadBalancerListener(s) to be removed.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the LoadBalancerPorts collection
The values to add to the LoadBalancerPorts collection
this instance
Adds elements to the LoadBalancerPorts collection
The values to add to the LoadBalancerPorts collection
this instance
The mnemonic name associated with the LoadBalancer.
The client port number(s) of the LoadBalancerListener(s) to be removed.
UpdateApplicationResult Unmarshaller
Delete Application Version Request Marshaller
Container for the parameters to the RebuildEnvironment operation.
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment
and forces a restart.
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
The ID of the environment to rebuild.
The name of the environment to rebuild.
Constraints:
-
Length
4 - 23
Returns information about the DescribeApplicationVersionsResult response and response metadata.
Gets and sets the DescribeApplicationVersionsResult property.
Result message wrapping a list of application version descriptions.
Container for the parameters to the CreateConfigurationTemplate operation.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of
the application with the same configuration settings. Related Topics
- DescribeConfigurationOptions
- DescribeConfigurationSettings
- ListAvailableSolutionStacks
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the SourceConfiguration property
The value to set for the SourceConfiguration property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the Description property
The value to set for the Description property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
The name of the configuration template. Constraint: This name must be unique per application. Default: If a configuration template already
exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application
server for a configuration template. It determines the set of configuration options as well as the possible and default values. Use
ListAvailableSolutionStacks to obtain a list of available solution stacks. Default: If the SolutionStackName is not specified
and the source configuration parameter is blank, AWS Elastic Beanstalk uses the default solution stack. If not specified and the source
configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
Constraints:
-
Length
0 - 100
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration. If
no configuration template is found, returns an InvalidParameterValue error. Constraint: If both the solution stack name parameter and
the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution
stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
The ID of the environment used with this configuration template.
Describes this configuration.
Constraints:
-
Length
0 - 200
If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value
obtained from the solution stack or the source configuration template.
Result message wrapping a single description of an application version.
Sets the ApplicationVersion property
The value to set for the ApplicationVersion property
this instance
The ApplicationVersionDescription of the application version.
Indicates if the specified CNAME is available.
Sets the Available property
The value to set for the Available property
this instance
Sets the FullyQualifiedCNAME property
The value to set for the FullyQualifiedCNAME property
this instance
Indicates if the specified CNAME is available: true : The CNAME is available. true : The CNAME is not available. - true : The CNAME is available.
-
false : The CNAME is not available.
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
Constraints:
-
Length
1 - 255
Describes the properties of an application version.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the SourceBundle property
The value to set for the SourceBundle property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
The name of the application associated with this release.
Constraints:
-
Length
1 - 100
The description of this application version.
Constraints:
-
Length
0 - 200
A label uniquely identifying the version for the associated application.
Constraints:
-
Length
1 - 100
The location where the source bundle is located for this version.
The creation date of the application version.
The last modified date of the application version.
VPC Attachment
Sets the VpcId property
The ID of the VPC the VPN gateway is attached to
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the VpcAttachmentState property
The current state of the attachment (attaching,
attached,
detaching, detached)
this instance
Checks if VpcAttachmentState property is set
true if VpcAttachmentState property is set
Gets and sets the VpcId property.
The ID of the VPC the VPN gateway is attached to
Gets and sets the VpcAttachmentState property.
The current state of the attachment (attaching,
attached,
detaching, detached)
A Snapshot of an EBS volume.
Sets the SnapshotId property
The ID of the snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the VolumeId property
The ID of the volume from which the snapshot
was created.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the Status property
Snapshot state - can be one of pending | completed | error
this instance
Checks if Status property is set
true if Status property is set
Sets the StartTime property
Time stamp when the snapshot was initiated.
this instance
Checks if StartTime property is set
true if StartTime property is set
Sets the Progress property
The progress of the snapshot, in percentage.
this instance
Checks if Progress property is set
true if Progress property is set
Sets the OwnerId property
AWS Access Key ID of the user who owns the
snapshot.
this instance
Checks if OwnerId property is set
true if OwnerId property is set
Sets the VolumeSize property
Size of the volume
this instance
Checks if VolumeSize property is set
true if VolumeSize property is set
Sets the Description property
Description of the snapshot.
this instance
Checks if Description property is set
true if Description property is set
Sets the OwnerAlias property
OwnerAlias property
this instance
Checks if OwnerAlias property is set
true if OwnerAlias property is set
Sets the Tag property
A list of tags for the Snapshot.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the SnapshotId property.
The ID of the snapshot.
Gets and sets the VolumeId property.
The ID of the volume from which the snapshot
was created.
Gets and sets the Status property.
Snapshot state - can be one of pending | completed | error
Gets and sets the StartTime property.
Time stamp when the snapshot was initiated.
Gets and sets the Progress property.
The progress of the snapshot, in percentage.
Gets and sets the OwnerId property.
AWS Access Key ID of the user who owns the
snapshot.
Gets and sets the VolumeSize property.
Size of the volume
Gets and sets the Description property.
Description of the snapshot.
Gets and sets the OwnerAlias property.
Gets and sets the Tag property.
A list of tags for the Snapshot.
The Response for the RequestSpotInstances
operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if RequestSpotInstancesResult property is set
true if RequestSpotInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the RequestSpotInstancesResult property.
Result of the Request Spot Instances operation.
Monitor Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if MonitorInstancesResult property is set
true if MonitorInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the MonitorInstancesResult property.
Monitor Instances Result
A software license that can be associated with an Amazon EC2
instance when launched (ex. a Microsoft Windows license).
Sets the LicenseId property
The unique ID identifying the license.
this instance
Checks if LicenseId property is set
true if LicenseId property is set
Sets the Type property
The license type (ex. "Microsoft/Windows/Standard").
this instance
Checks if Type property is set
true if Type property is set
Sets the Pool property
The name of the pool in which the license is kept.
this instance
Checks if Pool property is set
true if Pool property is set
Sets the LicenseCapacity property
The capacities available for this license,
indicating how many licenses are in use, how many are available,
how many Amazon EC2 instances can be supported, etc.
this instance
Checks if LicenseCapacity property is set
true if LicenseCapacity property is set
Sets the Tag property
A list of tags for the License.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the LicenseId property.
The unique ID identifying the license.
Gets and sets the Type property.
The license type (ex. "Microsoft/Windows/Standard").
Gets and sets the Pool property.
The name of the pool in which the license is kept.
Gets and sets the LicenseCapacity property.
The capacities available for this license,
indicating how many licenses are in use, how many are available,
how many Amazon EC2 instances can be supported, etc.
Gets and sets the Tag property.
A list of tags for the License.
Import Instance Result
Checks if ConversionTask property is set
true if ConversionTask property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ConversionTask property.
Information about the import instance task.
Get Password Data Result
Checks if PasswordData property is set
true if PasswordData property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets the decrypted password using the RSA private key which can be found in the
PEM file for the key pair.
The RSA private key from the PEM file
The decrypted password
Gets and sets the PasswordData property.
Password data
Error Response
Checks if Error property is set
true if Error property is set
Checks if RequestId property is set
true if RequestId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Error property.
Error
Gets and sets the RequestId property.
Request Id
Sets the Size property
Size of the volume.
this instance
Checks if Size property is set
true if Size property is set
Sets the Id property
Volume identifier.
this instance
Checks if Id property is set
true if Id property is set
Gets and sets the Size property.
Size of the volume.
Gets and sets the Id property.
Volume identifier.
Sets the Format property
Disk image format.
Valid Values: VMDK | RAW
this instance
Checks if Format property is set
true if Format property is set
Sets the Size property
Size of the disk image.
this instance
Checks if Size property is set
true if Size property is set
Sets the ImportManifestUrl property
The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about
creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the
Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
this instance
Checks if ImportManifestUrl property is set
true if ImportManifestUrl property is set
Sets the Checksum property
Checksum computed for the disk image.
this instance
Checks if Checksum property is set
true if Checksum property is set
Gets and sets the Format property.
Disk image format.
Valid Values: VMDK | RAW
Gets and sets the Size property.
Size of the disk image.
Gets and sets the ImportManifestUrl property.
The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about
creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the
Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
Gets and sets the Checksum property.
Checksum computed for the disk image.
Describe Volumes Result
Checks if Volume property is set
true if Volume property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Volume property.
List of volumes
Returns information about security groups that
you own.
Sets the GroupName property
Name of the security group.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the GroupId property
ID of the security group.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified SecurityGroups.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the GroupName property.
Name of the security group.
Gets and sets the GroupId property.
ID of the security group.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified SecurityGroups.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
DescribeNetworkAcls Result
Checks if NetworkAcls property is set
true if NetworkAcls property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the NetworkAcls property.
A list of NetworkAcls.
Deregisters the specified AMI. Once deregistered,
the AMI cannot be used to launch new instances.
This command does not
delete the AMI from Amazon S3.
Sets the ImageId property
Unique ID of the AMI which was assigned during
registration.
this instance
Checks if ImageId property is set
true if ImageId property is set
Gets and sets the ImageId property.
Unique ID of the AMI which was assigned during
registration.
Deletes tags from the specified resources.
Sets the ResourceId property
A list of one or more resource IDs.
this instance
Checks if ResourceId property is set
true if ResourceId property is set
Sets the Tag property
The tags to delete from the specified resources. Each tag item consists of a
key-value pair.
If a tag doesn't have a value defined in the key-value pair,
the tag is deleted regardless of its value.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the ResourceId property.
A list of one or more resource IDs.
Gets and sets the Tag property.
The tags to delete from the specified resources. Each tag item consists of a
key-value pair.
If a tag doesn't have a value defined in the key-value pair,
the tag is deleted regardless of its value.
Sets the Key property
Key property
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
Value property
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the Key property.
Gets and sets the Value property.
The Response for the
DeleteSpotDatafeedSubscription operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Information returned by the CreatePlacementGroup request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Sets the ConversionTaskId property
ID of the conversion task.
this instance
Checks if ConversionTaskId property is set
true if ConversionTaskId property is set
Sets the ExpirationTime property
When the task expires. If the upload isn't complete before the expiration time, the task is automatically canceled.
this instance
Checks if ExpirationTime property is set
true if ExpirationTime property is set
Sets the ImportVolumeRequest property
If the task is for importing a volume, this contains information about the import volume task.
this instance
Checks if ImportVolumeRequest property is set
true if ImportVolumeRequest property is set
Sets the ImportInstanceRequest property
If the task is for importing an instance, this contains information about the import instance task.
this instance
Checks if ImportInstanceRequest property is set
true if ImportInstanceRequest property is set
Sets the State property
State of the conversion task.
this instance
Checks if State property is set
true if State property is set
Sets the StatusMessage property
Status message related to the conversion task.
this instance
Checks if StatusMessage property is set
true if StatusMessage property is set
Gets and sets the ConversionTaskId property.
ID of the conversion task.
Gets and sets the ExpirationTime property.
When the task expires. If the upload isn't complete before the expiration time, the task is automatically canceled.
Gets and sets the ImportVolumeRequest property.
If the task is for importing a volume, this contains information about the import volume task.
Gets and sets the ImportInstanceRequest property.
If the task is for importing an instance, this contains information about the import instance task.
Gets and sets the State property.
State of the conversion task.
Gets and sets the StatusMessage property.
Status message related to the conversion task.
Confirm Product Instance Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ConfirmProductInstanceResult property is set
true if ConfirmProductInstanceResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ConfirmProductInstanceResult property.
Confirm Product Instance Result
A cancelled Spot Instance Request.
Sets the SpotInstanceRequestId property
The ID of the Spot Instance Request.
this instance
Checks if SpotInstanceRequestId property is set
true if SpotInstanceRequestId property is set
Sets the State property
The State of the Spot Instance Request.
Valid values are open | closed | cancelled | failed
this instance
Checks if State property is set
true if State property is set
Gets and sets the SpotInstanceRequestId property.
The ID of the Spot Instance Request.
Gets and sets the State property.
The State of the Spot Instance Request.
Valid values are open | closed | cancelled | failed
Cancels an active conversion task. The task can be the import of an instance or volume. The command removes all artifacts of the conversion, including a
partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
Sets the ConversionTaskId property
The ID of the task you want to cancel.
this instance
Checks if ConversionTaskId property is set
true if ConversionTaskId property is set
Gets and sets the ConversionTaskId property.
The ID of the task you want to cancel.
Adds permissions to a security group.
Permissions are specified by the IP protocol (TCP, UDP or ICMP),
the source of the request (by IP range or an Amazon EC2 user-group pair),
the source and destination port ranges (for TCP and UDP), and the
ICMP codes and types (for ICMP). When authorizing ICMP, -1 can
be used as a wildcard in the type and code fields.
Permission changes are propagated to instances within the
security group as quickly as possible. However, depending on
the number of instances, a small delay might occur.
When authorizing a user/group pair permission,
GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId
must be specified. When authorizing a CIDR IP permission,
GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified
Sets the UserId property
AWS Access Key ID.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the GroupId property
Id of the standard (EC2) or VPC security group to modify. Conditional
The group must belong to your account.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
Name of the group to modify. The name must be
valid and belong to the account
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the SourceSecurityGroupName property
Name of the security group. Cannot be used
when specifying a CIDR IP address.
this instance
Checks if SourceSecurityGroupName property is set
true if SourceSecurityGroupName property is set
Sets the SourceSecurityGroupOwnerId property
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
this instance
Checks if SourceSecurityGroupOwnerId property is set
true if SourceSecurityGroupOwnerId property is set
Sets the IpProtocol property
IP protocol.
this instance
Checks if IpProtocol property is set
true if IpProtocol property is set
Sets the FromPort property
Start of port range for the TCP and UDP protocols, or an ICMP type number.
An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).
this instance
Checks if FromPort property is set
true if FromPort property is set
Sets the ToPort property
End of port range for the TCP and UDP protocols, or an ICMP code.
An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).
this instance
Checks if ToPort property is set
true if ToPort property is set
Sets the CidrIp property
CIDR range.
this instance
Checks if CidrIp property is set
true if CidrIp property is set
Sets the IpPermissions property
Set of IP permissions associated with the
security group.
this instance
Checks if IpPermissions property is set
true if IpPermissions property is set
Gets and sets the UserId property.
AWS Access Key ID.
Gets and sets the GroupId property.
Id of the standard (EC2) or VPC security group to modify. Conditional
The group must belong to your account.
Gets and sets the GroupName property.
Name of the group to modify. The name must be
valid and belong to the account
Gets and sets the SourceSecurityGroupName property.
Name of the security group. Cannot be used
when specifying a CIDR IP address.
Gets and sets the SourceSecurityGroupOwnerId property.
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
Gets and sets the IpProtocol property.
IP protocol.
Gets and sets the FromPort property.
Start of port range for the TCP and UDP protocols, or an ICMP type number.
An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).
Gets and sets the ToPort property.
End of port range for the TCP and UDP protocols, or an ICMP code.
An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).
Gets and sets the CidrIp property.
CIDR range.
Gets and sets the IpPermissions property.
Set of IP permissions associated with the
security group.
Response Unmarshaller for DescribeAlarms operation
AmazonCloudWatch exception
Constructs a new InternalServiceException with the specified error
message.
Describes the error encountered.
Returns information about the DeleteAlarms response metadata.
The DeleteAlarms operation has a void result type.
The UrlTrustedSigners complex type specifies any AWS accounts you want to permit to create signed URLs for private content.
To specify who can sign URLs
- Enable yourself to be a trusted signer (you must explicitly give yourself permission).
- Add an AwsAccountNumber for each AWS account (other than your own) that you want to give signing
authority (limit of five). Remove the dashes from the account number.
If you want the distribution to use signed URLs, include this element in the DistributionConfig for your CloudFront
distribution either while creating the distribution or by updating the distribution's config.
For more information, please visit:
Creates an string representation of the UrlTrustedSigners object
by overriding the default Object ToString method. This string
can be concatenated to the distribution config xml that is sent
to CloudFront while creating a distribution or updating a distribution's
configuration.
String representation of the UrlTrustedSigners type.
Sets the AwsAccountNumbers property. Please provide the AWS account number without dashes.
If you set more than 5 trusted signers for URLs,
a TooManyTrustedSigners exception will be returned by CloudFront.
Value that the AwsAccountNumbers property will be set to
this instance
Checks if AwsAccountNumbers property is set
true if AwsAccountNumbers property is set
Sets the EnableSelf property
EnableSelf property
this instance
Gets and sets the AwsAccountNumbers property.
A list of the AwsAccountNumbers for each AWS account (other than your own)
that you want to give URL signing authority to (limit of five).
Gets and sets the EnableSelf property.
Whether your own AWS account is authorized to sign URLs.
Default - your AWS account is not authorized to sign URLs.
The PostInvalidationRequest contains the parameters used for the PostInvalidation operation.
Required Parameter: DistributionId, InvalidationBatch.CallerReference
Default constructor
Constructs and instance of PostInvalidationRequest with an InvalidationBatch which will be
set to the InvalidationBatch property.
The InvalidationBatch property that will be set to the InvalidationBatch property.
Sets the DistributionId property of this request to the value passed in.
The distribution's id
The request with the DistributionId property set
Sets the InvalidationBatch property of this request to the value passed in.
An InvalidationBatch object that lists all the paths of objects to be invalidated.
The request with the InvalidationBatch property set
Gets and Sets the DistributionId property for the Distribution
Gets and Sets the InvalidationBatch which contains the list of objects to invalidated.
Represents an error returned by the CloudFront service. Exposes
an error code, a message, a host ID and a request ID for
debugging purposes.
Sets the Code property.
Code property
this instance
Checks if Code property is set.
true if Code property is set.
Gets and sets the Code property.
Gets and sets the Message property.
Gets and sets the Type property.
Gets and sets the RequestId property.
The CloudFrontDistributionConfig complex type describes a distribution's configuration information.
It is used as a request element in Create a Distribution and Set a Distribution's Configuration.
It is used as a response element in Get a Distribution's Information and Get a Distribution's
Configuration.
A distribution configuration objects consists of the following items:
- Caller Reference
- Origin S3 Bucket
- Comment
- A list of CNAMEs for the distribution
- Enabled flag
- Bucket Logging details
- CloudFront Origin Access Identity associated with the distribution.
This is a virtual identity you use to let CloudFront fetch private content
from your bucket.
- The AWS Accounts that have URL signing privileges for Private Content.
For more information, please visit:
Creates an XML representation of the CloudFront
distribution configuration. The resulting XML
can be sent to CloudFront when creating or updating
a distribution.
XML representation of the distribution's configuration
Sets the Origin property.
Origin property
this instance
Sets the Comment property.
Comment property
this instance
Sets the CallerReference property
CallerReference property
this instance
Sets the CNAME property. If you set more than 10 CNAME aliases for a distribution,
a TooManyDistributionCNAMEs exception will be returned by CloudFront.
CNAME property
this instance
Sets the Enabled property
Enabled property
this instance
Sets the OriginAccessIdentity property.
OriginAccessIdentity property
this instance
Sets the TrustedSigners property.
This specifies any AWS accounts you want to permit to create signed URLs for private content.
TrustedSigners property is set to this value
this instance
Sets the CustomOrigin property.
The CustomOrigin contains the information for a non Amazon S3 Bucket origin.
This instance is returned to allow method chaining.
CustomOrigin property is set to this value.
This instance
Sets the Logging property.
The bucket into which logs will be put
The prefix for the log files
this instance
Checks if RequiredProtocols property is set.
true if RequiredProtocols property is set.
Sets the RequiredProtocols property.
Defines the protocols required for your distribution. Use this element to restrict
access to your distribution solely to HTTPS requests. Without this element,
CloudFront can use any available protocol to serve the request.
For a list of possible protocol values, refer
.
RequiredProtocols property is set to this value
this instance
Sets the DefaultRootObject property.
The name of the default root object.
This instance.
Checks to see if the DefaultRootObject property is set.
True if DefaultRootObject is set. False otherwise.
Gets and sets the CustomOrigin property.
The CustomOrigin contains the information for a non Amazon S3 Bucket origin.
Gets and sets the RequiredProtocols property.
Defines the protocols required for your distribution. Use this element to restrict
access to your distribution solely to HTTPS requests. Without this element,
CloudFront can use any available protocol to serve the request.
For a list of possible protocol values, refer
.
Gets and sets the DefaultRootObject property.
Defines the object that will be returned for requests made to the root URL of
the distribution.
The output for ValidateTemplate action.
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Sets the Description property
The value to set for the Description property
this instance
A list of TemplateParameter structures.
The description found within the template.
StackResourceSummary Unmarshaller
StackResourceDetail Unmarshaller
DescribeStackResourceResult Unmarshaller
Delete Stack Request Marshaller
CreateStackResult Unmarshaller
The StackResource data type.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the StackId property
The value to set for the StackId property
this instance
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
Sets the PhysicalResourceId property
The value to set for the PhysicalResourceId property
this instance
Sets the ResourceType property
The value to set for the ResourceType property
this instance
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the ResourceStatus property
The value to set for the ResourceStatus property
this instance
Sets the ResourceStatusReason property
The value to set for the ResourceStatusReason property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name associated with the stack.
Unique identifier of the stack.
The logical name of the resource specified in the template.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
Type of the resource. (For more information, go to the AWS
CloudFormation User Guide.)
Time the status was updated.
Current status of the resource.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
Success/failure message associated with the resource.
User defined description associated with the resource.
The output for a DescribeStackResource action.
Sets the StackResourceDetail property
The value to set for the StackResourceDetail property
this instance
A StackResourceDetail structure containing the description of the specified resource in the specified stack.
Terminate Instance In Auto Scaling Group Request Marshaller
PutScalingPolicyResult Unmarshaller
Response Unmarshaller for PutScalingPolicy operation
Response Unmarshaller for DescribeNotificationConfigurations operation
Describe Metric Collection Types Request Marshaller
Describe Auto Scaling Groups Request Marshaller
Delete Scheduled Action Request Marshaller
Response Unmarshaller for DeleteAutoScalingGroup operation
AutoScalingInstanceDetails Unmarshaller
Container for the parameters to the SetInstanceHealth operation.
Sets the health status of an instance.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Sets the HealthStatus property
The value to set for the HealthStatus property
this instance
Sets the ShouldRespectGracePeriod property
The value to set for the ShouldRespectGracePeriod property
this instance
The identifier of the EC2 instance.
Constraints:
-
Length
1 - 16
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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. Auto Scaling should terminate and replace it.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
If True, this call should respect the grace period associated with the group.
Container for the parameters to the DescribeScalingProcessTypes operation.
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
Container for the parameters to the DescribePolicies operation.
Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more
records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group
name is provided, the results are limited to that group.The list of requested policy names cannot contain more than 50 items. If unknown
policy names are requested, they are ignored with no error.
A string that is used to mark the start of the next batch of returned results for pagination.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The maximum number of policies that will be described with each call.
Constraints:
-
Range
1 - 50
Returns information about the DescribeNotificationConfigurationsResult response and response metadata.
Gets and sets the DescribeNotificationConfigurationsResult property.
The output of the DescribeNotificationConfigurations action.
The AutoScalingGroupsType data type.
Adds elements to the AutoScalingGroups collection
The values to add to the AutoScalingGroups collection
this instance
Adds elements to the AutoScalingGroups collection
The values to add to the AutoScalingGroups collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of Auto Scaling groups.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Represents a resource involved in an AWS access control policy statement.
Resources are the service specific AWS entities owned by your account. Amazon
SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all
examples of AWS resources.
The standard way of specifying an AWS resource is with an Amazon Resource
Name (ARN).
The resource is C in the statement
"A has permission to do B to C where D applies."
Constructs a new AWS access control policy resource. Resources are
typically specified as Amazon Resource Names (ARNs).
You specify the resource using the following Amazon Resource Name (ARN)
format: arn:aws:<vendor>:<region>:<namespace>:<relative-id>
-
>vendor identifies the AWS product (e.g., sns)
-
region is the AWS Region the resource resides in (e.g., us-east-1), if any
-
namespace is the AWS account ID with no hyphens (e.g., 123456789012)
-
relative-id is the service specific portion that identifies the specific resource
For example, an Amazon SQS queue might be addressed with the following
ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue
Some resources may not use every field in an ARN. For example, resources
in Amazon S3 are global, so they omit the region field:
arn:aws:s3:::bucket/*
The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource.
Gets the resource ID, typically an Amazon Resource Name (ARN),
identifying this resource.
The available AWS access control policy actions for Amazon Simple Queue
Service.
Represents any action being taken on Amazon SQS.
Action for the AddPermission operation on Amazon SQS.
Action for the ChangeMessageVisibility operation on Amazon SQS.
Action for the CreateQueue operation on Amazon SQS.
Action for the DeleteMessage operation on Amazon SQS.
Action for the DeleteQueue operation on Amazon SQS.
Action for the GetQueueAttributes operation on Amazon SQS.
Action for the ListQueues operation on Amazon SQS.
Action for the ReceiveMessage operation on Amazon SQS.
Action for the RemovePermission operation on Amazon SQS.
Action for the SendMessage operation on Amazon SQS.
Action for the SetQueueAttributes operation on Amazon SQS.
The available AWS access control policy actions for Amazon CloudFront.
Represents any action being taken on AWS CloudFormation.
Action for the CreateDistribution operation.
Action for the GetDistributionInfo operation.
Action for the GetDistributionConfig operation.
Action for the SetDistributionConfig operation.
Action for the ListDistributions operation.
Action for the DeleteDistribution operation.
Action for the CreateStreamingDistribution operation.
Action for the GetStreamingDistributionInfo operation.
Action for the GetStreamingDistributionConfig operation.
Action for the SetStreamingDistributionConfig operation.
Action for the ListStreamingDistributions operation.
Action for the DeleteStreamingDistribution operation.
Action for the PostInvalidation operation.
Action for the GetInvalidation operation.
Action for the GetInvalidationList operation.
Action for the CreateOriginAccessIdentity operation.
Action for the GetOriginAccessIdentityInfo operation.
Action for the GetOriginAccessIdentityConfig operation.
Action for the SetOriginAccessIdentityConfig operation.
Action for the ListOriginAccessIdentities operation.
Action for the DeleteOriginAccessIdentity operation.
A
return a = a + b - b preserved.
unsigned comparison on two arrays - note the arrays may
start with leading zeros.
returns x = x - y - we assume x is >= y
return the object at the sequence position indicated by index.
@param index the sequence number (starting at zero) of the object
@return the object at the sequence position indicated by index.
create an empty sequence
create a sequence containing one object
create a sequence containing a vector of objects.
A list of errors associated with a request returned by Amazon SQS.
Checks if Error property is set
true if Error property is set
Checks if RequestId property is set
true if RequestId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Error property.
Error
Gets and sets the RequestId property.
A unique ID for tracking the request.
The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message
is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the ReceiptHandle property
The receipt handle associated with the message you want to delete.
this instance
Checks if ReceiptHandle property is set
true if ReceiptHandle property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the ReceiptHandle property.
The receipt handle associated with the message you want to delete.
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
Name and value pair of an attribute associated with the queue.
Sets the Name property
Name of the attribute.
this instance
Checks if Name property is set
true if Name property is set
Sets the Value property
Values of the attribute.
this instance
Checks if Value property is set
true if Value property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Name property.
Name of the attribute.
Gets and sets the Value property.
Values of the attribute.
The Unsubscribe action deletes a subscription. If the subscription requires authentication for
deletion, only the owner of the subscription or the its topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester is not
the subscription owner, a final cancellation message is delivered to the
endpoint, so that the endpoint owner can easily resubscribe to the topic if
the Unsubscribe request was unintended.
Sets the SubscriptionArn property
The ARN of the subscription to be deleted.
this instance
Checks if SubscriptionArn property is set
true if SubscriptionArn property is set
Gets and sets the SubscriptionArn property.
The ARN of the subscription to be deleted.
Container for the parameters to the VerifyEmailAddress operation.
Verifies an email address. This action causes a confirmation
email message to be sent to the specified address.
Sets the EmailAddress property
The value to set for the EmailAddress property
this instance
The email address to be verified.
SendDataPoint Unmarshaller
Container for the parameters to the ListVerifiedEmailAddresses operation.
Returns a list containing all of the email addresses that have
been verified.
Represents the body of the message. You can specify text, HTML,
or both. If you use both, then the message should display correctly in
the widest variety of email clients.
Default constructor for a new Body object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Body object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks
(such as mobile devices).
Sets the Text property
The value to set for the Text property
this instance
Sets the Html property
The value to set for the Html property
this instance
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile
devices).
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted
text, and much more in an HTML message.
The Select operation returns a set of Attributes for ItemNames that match the select expression.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items
returned per page to enforce this limit. For example, even if you ask to retrieve 2500 items, but each individual
item is 10 kB in size, the system returns 100 items and an appropriate next token so you can get the next page of results.
Operations that run longer than 5 seconds return a time-out error response or a partial or empty result set. Partial
and empty result sets contains a next token which allow you to continue the operation from where it left off.
Responses larger than one megabyte return a partial result set.
Sets the Item property
Items represent individual objects that contain one or more attribute name-value pairs.
this instance
Checks if Item property is set
true if Item property is set
Sets the NextToken property
An opaque token indicating that more than MaxNumberOfItems matched, the response size exceeded 1 megabyte,
or the execution time exceeded 5 seconds.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the Item property.
Items represent individual objects that contain one or more attribute name-value pairs.
Gets and sets the NextToken property.
An opaque token indicating that more than MaxNumberOfItems matched, the response size exceeded 1 megabyte,
or the execution time exceeded 5 seconds.
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
Sets the Name property
The name of the attribute.
this instance
Checks if Name property is set
true if Name property is set
Sets the Value property
The value of the attribute.
this instance
Checks if Value property is set
true if Value property is set
Sets the NameEncoding property
The encoding for the attribute's name. For example: base64
this instance
Checks if NameEncoding property is set
true if NameEncoding property is set
Sets the ValueEncoding property
The encoding for the attribute's value. For example: base64
this instance
Checks if ValueEncoding property is set
true if ValueEncoding property is set
Gets and sets the Name property.
The name of the attribute.
Gets and sets the Value property.
The value of the attribute.
Gets and sets the NameEncoding property.
The encoding for the attribute's name. For example: base64
Gets and sets the ValueEncoding property.
The encoding for the attribute's value. For example: base64
Contains all the parameters
that can be set when making a this request with the
TransferUtility method.
Sets the name of the bucket
and returns this object instance,
enabling additional method calls to be chained together.
The name of the bucket.
This object instance, enabling additional method calls to be chained together.
Checks if BucketName property is set.
true if BucketName property is set.
Sets the key under which the Amazon S3 object is stored
and returns this object instance,
enabling additional method calls to be chained together.
The key under which the Amazon S3 object is stored.
This object instance, enabling additional method calls to be chained together.
Checks if Key property is set.
true if Key property is set.
Gets or sets the canned access control list (ACL)
for the uploaded object.
Please refer to
for
information on Amazon S3 canned ACLs.
The canned access control list (ACL)
for the uploaded object.
Checks if the CannedACL property is set.
true if there is the CannedACL property is set.
Removes the cannned access control list (ACL)
for the uploaded object.
Sets the content type of the uploaded Amazon S3 object.
and returns this object instance,
enabling additional method calls to be chained together.
This property defaults to binary/octet-stream.
the value the ContentType to be set to
This object instance, enabling additional method calls to be chained together.
Checks if ContentType property is set.
true if ContentType property is set.
Adds a set of key-value pairs to the request
and returns this object instance,
enabling additional method calls to be chained together.
The key to associate with the Amazon S3 object.
The value for the key.
This object instance, enabling additional method calls to be chained together.
Adds a set of key-value pairs to the request
and returns this object instance,
enabling additional method calls to be chained together.
The set of key-value pairs
associated with the Amazon S3 object.
This object instance, enabling additional method calls to be chained together.
Checks if Metadata property is set.
true if Metadata property is set.
Removes a key from the metadata list if it was
added previously.
The key to remove.
Sets the storage class for the uploaded Amazon S3 object.
and returns this object instance,
enabling additional method calls to be chained together.
Please refer to
for
information on S3 Storage Classes.
The storage class for the uploaded Amazon S3 object.
This object instance, enabling additional method calls to be chained together.
Sets the file path location of where the
Amazon S3 object will be uploaded from
and returns this object instance,
enabling additional method calls to be chained together.
The value that FilePath is set to
This object instance, enabling additional method calls to be chained together.
Checks if FilePath property is set.
true if FilePath property is set.
Sets the sets the timeout property in milliseconds
and returns this object instance,
enabling additional method calls to be chained together.
Set the timeout only if certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
The timeout in milliseconds.
A value less than or equal to 0 will be silently ignored.
This object instance, enabling additional method calls to be chained together.
Sets the part size of the upload in bytes
and returns this object instance,
enabling additional method calls to be chained together.
The uploaded file will be divided into
parts the size specified and
uploaded to Amazon S3 individually.
The part size of the upload.
This object instance, enabling additional method calls to be chained together.
Checks if PartSize property is set.
true if PartSize property is set.
The handler will be attached to the UploadProgressEvent which is fired as data
is uploaded to S3. The handler will be passed information detailing how much data
has been uploaded as well as how much will be uploaded.
A method that is called when UploadProgressEvent is fired.
this instance of the TransferUtilityUploadRequest
Causes the UploadProgressEvent event to be fired.
The how many bytes were transferred since last event.
How many bytes have been transferred.
The total number of bytes to be tranferred.
Sets whether or not the stream used with this request is
automatically closed when all of the content is read from the stream
and returns this object instance,
enabling additional method calls to be chained together.
A value of true if the if the stream is
automatically closed when all of the content is read from the stream.
A value of false if otherwise.
This object instance, enabling additional method calls to be chained together.
Gets or sets the name of the bucket.
The name of the bucket.
Gets or sets the key under which the Amazon S3 object is to be stored.
The key under which the Amazon S3 object is to be stored.
Gets or sets the canned access control list (ACL)
for the uploaded object.
Please refer to
for
information on Amazon S3 canned ACLs.
The canned access control list (ACL)
for the uploaded object.
Gets or sets the content type of the uploaded Amazon S3 object.
The content type of the uploaded Amazon S3 object.
Gets or sets the storage class for the uploaded Amazon S3 object.
Please refer to
for
information on S3 Storage Classes.
The storage class for the uploaded Amazon S3 object.
Gets or sets the file path
where the Amazon S3 object will be uploaded from.
The file path where the Amazon S3 object will be uploaded from.
Gets or sets the timeout property in milliseconds.
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for Amazon S3 GET Object requests.
A value less than or equal to 0 will be silently ignored.
Gets or sets the part size of the upload in bytes.
The uploaded file will be divided into
parts the size specified and
uploaded to Amazon S3 individually.
The part size of the upload.
The event for UploadProgressEvent notifications. All
subscribers will be notified when a new progress
event is raised.
The UploadProgressEvent is fired as data
is uploaded to S3. The delegates attached to the event
will be passed information detailing how much data
has been uploaded as well as how much will be uploaded.
Subscribe to this event if you want to receive
UploadProgressEvent notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, UploadProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the UploadProgressEvent delegate's invocation list
TransferUtilityUploadRequest request = new TransferUtilityUploadRequest();
request.UploadProgressEvent += displayProgress;
Gets the length of the content by either checking the FileInfo.Length property or the Stream.Length property.
The length of the content.
Gets or sets whether or not the stream used with this request is
automatically closed when all of the content is read from the stream.
A value of true if the if the stream is
automatically closed when all of the content is read from the stream.
A value of false if otherwise.
Encapsulates the information needed to provide
transfer progress to subscribers of the Put Object
Event.
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
The how many bytes were transferred since last event.
The number of bytes transferred
The total number of bytes to be transferred
This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request
and uploads them.
The GetBucketLocationRequest contains the parameters used for the GetBucketLocation operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
The GetACLResponse contains all the information about the
GetACL operation.
Gets and sets the AccessControlList property.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
The GetACLRequest contains the parameters used for the GetACL operation.
The BucketName is always required, the Key is optional and is to be set
if you want the ACL for an object instead of a bucket.
Required Parameters: BucketName
Optional Parameters: Key, VersionId
Sets the BucketName property for this request.
This is either the S3 Bucket whose ACL you want to get,
or the S3 Bucket that has the S3 Object whose ACL
you want to get.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object whose ACL you
want to get.
The value that Key is set to
this instance
Checks if Key property is set.
true if Key property is set.
Sets the VersionId property for this request.
This is the Version Id of the S3 Object for
which the ACL will be retrieved. This property
is ignored if the ACL is requested for a Bucket.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the VersionId property.
This is the Version Id of the S3 Object for
which the ACL will be retrieved. This property
is ignored if the ACL is requested for a Bucket.
Represents an S3 Bucket Versioning Configuration.
Contains the buckets VersioningStatus - Off, Enabled, Suspended.
Whether an MFADelete has been enabled for the bucket.
Provides the XML representation of the S3BucketVersioningConfig
A String representation of the S3BucketVersioningConfig Object.
Sets the Status property.
The value for the Status property
The Versioning Configuration object with status modified
Checks if Status property is set
true if Status property is set
Sets the EnableMfaDelete property. If this property is set,
please ensure that the SetBucketVersioningRequest's MfaCodes
property is set with the Serial of and Token on the MFA device.
Whether MfaDelete will be enabled on the S3 Bucket
The S3 Versioning Configuration object with EnableMfaDelete modified
Checks if EnableMfaDelete property is set.
true if Status property is set
Gets and sets the Status property.
Accepted Values are Off, Enabled, Suspended
Gets and Sets the EnableMfaDelete property.
Specifies whether MFA Delete is enabled on this S3 Bucket.
If this property is set, please ensure that the
SetBucketVersioningRequest's MfaCodes property is set with
the Serial of and Token on the MFA device.
The EnableBucketLoggingResponse contains any headers returned by S3.
The DisableBucketLoggingResponse contains any headers returned by S3.
A container object for holding the part number and etag used when completing a
multipart upload.
Default constructor.
Compares the current object with another object of the same type.
An object to compare with this object.
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:
Value
Meaning
Less than zero
This object is less than the parameter.
Zero
This object is equal to .
Greater than zero
This object is greater than .
Constructs an instance of PartETag and sets the part number and etag.
The part number.
the associated ETag for the part number.
Sets the PartNumber property for this request.
The value that PartNumber is set to
the request with the PartNumber set
Sets the ETag property for this request.
The value that ETag is set to
the request with the ETag set
Gets and sets the PartNumber property.
Gets and sets the ETag property.
The InitiateMultipartUploadResponse contains all the information about the
InitiateMultipartUpload method.
Gets and sets the name of the bucket.
Gets and sets the object key for which the multipart upload was initiated.
Gets and sets the initiated multipart upload id.
The GetNotificationConfigurationResponse contains all the information about the
GetNotificationConfiguration operation.
Gets and sets the NotificationConfigurationList property.
The GetBucketWebsiteResponse contains the properties for S3 website configuration and
any headers returned by S3.
Sets the WithWebsiteConfiguration property for this request.
The value that WithWebsiteConfiguration is set to
the request with the WebsiteConfiguration set
Gets and sets the WebsiteConfiguration property.
This is where the index document suffix and custom error page are defined.
The GetBucketWebsiteRequest contains the parameters used for the GetBucketWebsiteRequest operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket whose website configuration will be fetched.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
This exception is thrown if there are problems signing the request.
Response Unmarshaller for all Errors
Build an ErrorResponse from XML
The XML parsing context.
Usually an Amazon.Runtime.Internal.UnmarshallerContext.
An ErrorResponse object.
Return an instance of and ErrorResponseUnmarshaller.
Response Unmarshaller for RebootDBInstance operation
Purchase Reserved D B Instances Offering Request Marshaller
Modify D B Instance Request Marshaller
Authorize D B Security Group Ingress Request Marshaller
AmazonRDS exception
Constructs a new SnapshotQuotaExceededException with the specified error
message.
Describes the error encountered.
AmazonRDS exception
Constructs a new ReservedDBInstanceQuotaExceededException with the specified error
message.
Describes the error encountered.
Container for the parameters to the ModifyDBInstance operation.
Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and
the new values in the request.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the AllocatedStorage property
The value to set for the AllocatedStorage property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Sets the ApplyImmediately property
The value to set for the ApplyImmediately property
this instance
Sets the MasterUserPassword property
The value to set for the MasterUserPassword property
this instance
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the BackupRetentionPeriod property
The value to set for the BackupRetentionPeriod property
this instance
Sets the PreferredBackupWindow property
The value to set for the PreferredBackupWindow property
this instance
Sets the PreferredMaintenanceWindow property
The value to set for the PreferredMaintenanceWindow property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the AllowMajorVersionUpgrade property
The value to set for the AllowMajorVersionUpgrade property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
The DB Instance identifier. This value is stored as a lowercase string. Constraints: - Must be the identifier for an existing DB
Instance
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end
with a hyphen or contain two consecutive hyphens
Example: mydbinstance
The new storage capacity of the RDS instance. This change does not result in an outage and is applied during the next maintenance window
unless the ApplyImmediately parameter is specified as true for this request. MySQL Default: Uses existing setting Valid
Values: 5-1024 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater
than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer MySQL Default: Uses
existing setting Valid Values: 10-1024 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not
at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
The new compute and memory capacity of the DB Instance. Passing a value for this parameter causes an outage during the change and is applied
during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request. Default: Uses
existing setting Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge
A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible. Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two
consecutive hyphens
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the DB Instance. If this parameter is passed as false, changes to the
DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever
occurs first. Default: false
The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request
and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation
response. Default: Uses existing setting Constraints: Must be 4 to 41 alphanumeric characters (engine specific) Amazon RDS APIs never
return the password, so this API provides a way to regain access to a master instance user if the password is lost.
The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters
when the ApplyImmediately parameter is specified as true for this request. Default: Uses existing setting Constraints: The DB
Parameter Group must be in the same DB Parameter Group family as this DB Instance.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0
disables automated backups. Default: Uses existing setting Constraints: - Must be a value from 0 to 8
- Cannot be set to 0 if
the DB Instance is a master instance with read replicas or of the DB Instance is a read replica
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod. Constraints: - Must be in the format hh24:mi-hh24:mi
- Times should be Universal Time
Coordinated (UTC)
- Must not conflict with the preferred maintenance window
- Must be at least 30 minutes
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If
moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending
changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Specifies if the DB Instance is a Multi-AZ deployment. Constraints: Cannot be specified if the DB Instance is a read replica.
The version number of the database engine to upgrade to. For major version upgrades, if a nondefault DB Parameter Group is currently in use,
a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be
the default for that DB Parameter Group Family. Example: 5.1.42
Indicates that major version upgrades are allowed. Constraints: This parameter must be set to true when specifying a value for the
EngineVersion parameter that is a different major version than the DB Instance's current version.
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
AmazonRDS exception
Constructs a new InvalidDBSecurityGroupStateException with the specified error
message.
Describes the error encountered.
Returns information about the DescribeOrderableDBInstanceOptionsResult response and response metadata.
Gets and sets the DescribeOrderableDBInstanceOptionsResult property.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
Returns information about the DescribeEventsResult response and response metadata.
Gets and sets the DescribeEventsResult property.
Contains the result of a successful invocation of the DescribeEvents action.
Container for the parameters to the DescribeEvents operation.
Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events
specific to a particular DB Instance, database security group, database snapshot or database parameter group can be obtained by providing
the name as a parameter. By default, the past hour of events are returned.
Sets the SourceIdentifier property
The value to set for the SourceIdentifier property
this instance
Sets the SourceType property
The value to set for the SourceType property
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the EndTime property
The value to set for the EndTime property
this instance
Sets the Duration property
The value to set for the Duration property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Constraints: - If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is DBInstance, then a
DBInstanceIdentifier must be supplied.
- If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
- If
the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
- If the source type is DBSnapshot, a
DBSnapshotIdentifier must be supplied.
- Cannot end with a hyphen or contain two consecutive hyphens.
The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
-
Allowed Values
db-instance, db-parameter-group, db-security-group, db-snapshot
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
The number of minutes to retrieve events for. Default: 60
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
Returns information about the DescribeDBParameterGroupsResult response and response metadata.
Gets and sets the DescribeDBParameterGroupsResult property.
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
Returns information about the DescribeDBInstancesResult response and response metadata.
Gets and sets the DescribeDBInstancesResult property.
Contains the result of a successful invocation of the DescribeDBInstances action.
Returns information about the DeleteDBSnapshot response and response metadata.
Gets and sets the DeleteDBSnapshotResult property.
Contains the result of a successful invocation of the DeleteDBSnapshot
action.
The results from the CreateDBInstance action.
Gets and sets the CreateDBInstanceResult property.
Contains the result of a successful invocation of the CreateDBInstance
action.
AmazonRDS exception
Constructs a new AuthorizationNotFoundException with the specified error
message.
Describes the error encountered.
Update Job Request Marshaller
List Jobs Request Marshaller
AmazonImportExport exception
Constructs a new InvalidAddressException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new BucketPermissionException with the specified error
message.
Describes the error encountered.
ListAccessKeysResult Unmarshaller
GetAccountSummaryResult Unmarshaller
Response Unmarshaller for DeleteGroupPolicy operation
Response Unmarshaller for CreateAccountAlias operation
AccessKey Unmarshaller
AmazonIdentityManagementService exception
Constructs a new NoSuchEntityException with the specified error
message.
Describes the error encountered.
Container for the parameters to the GetUser operation.
Retrieves information about the specified User, including the
User's path, GUID, and ARN. If you do not specify a User
name, IAM determines the User name implicitly based on the AWS Access
Key ID signing the request.
Sets the UserName property
The value to set for the UserName property
this instance
Name of the User to get information about. This parameter is optional. If it is not included, it defaults to the User making the request.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Returns information about the GetGroupResult response and response metadata.
Gets and sets the GetGroupResult property.
Contains the result of a successful invocation of the GetGroup action.
Contains the result of a successful invocation of the
CreateLoginProfile action.
Sets the LoginProfile property
The value to set for the LoginProfile property
this instance
The new login profile.
Terminate Job Flows Request Marshaller
BootstrapActionConfig Unmarshaller
This class provides helper methods for creating common Elastic MapReduce step
types. To use StepFactory, you should construct it with the appropriate bucket
for your region. The official bucket format is "<region>.elasticmapreduce", so
us-east-1 would use the bucket "us-east-1.elasticmapreduce".
Create an interactive Hive job flow with debugging enabled:
AmazonElasticMapReduce emr = AWSClientFactory.CreateAmazonElasticMapReduceClient(accessKey, secretKey);
StepFactory stepFactory = new StepFactory();
StepConfig enableDebugging = new StepConfig()
.WithName("Enable Debugging")
.WithActionOnFailure("TERMINATE_JOB_FLOW")
.WithHadoopJarStep(stepFactory.NewEnableDebuggingStep());
StepConfig installHive = new StepConfig()
.WithName("Install Hive")
.WithActionOnFailure("TERMINATE_JOB_FLOW")
.WithHadoopJarStep(stepFactory.NewInstallHiveStep());
RunJobFlowRequest request = new RunJobFlowRequest()
.WithName("Hive Interactive")
.WithSteps(enableDebugging, installHive)
.WithLogUri("s3://log-bucket/")
.WithInstances(new JobFlowInstancesConfig()
.WithEc2KeyName("keypair")
.WithHadoopVersion("0.20")
.WithInstanceCount(5)
.WithKeepJobFlowAliveWhenNoSteps(true)
.WithMasterInstanceType("m1.small")
.WithSlaveInstanceType("m1.small"));
RunJobFlowResponse response = emr.RunJobFlow(request);
Runs a specified script on the master node of your cluster.
The script to run
Arguments to be passed to the script.
HadoopJarStepConfig that can be passed to your job flow.
When run as the first step in your job flow, enables the Hadoop debugging UI
in the AWS Management Console.
HadoopJarStepConfig that can be passed to your job flow.
Step that installs Hive on your job flow.
The versions of Hive to install.
HadoopJarStepConfig that can be passed to your job flow.
Step that installs Hive on your job flow.
HadoopJarStepConfig that can be passed to your job flow.
Step that runs a Hive script on your job flow.
The script to run.
Arguments that get passed to the script.
HadoopJarStepConfig that can be passed to your job flow.
Step that installs Pig on your job flow.
HadoopJarStepConfig that can be passed to your job flow.
Step that runs a Pig script on your job flow.
The script to run.
Arguments that get passed to the script.
HadoopJarStepConfig that can be passed to your job flow.
The available Hive versions. These are only available on Hadoop 0.20
Hive_0_5 Hive 0.5
Hive_0_7 Hive 0.7
Describes the status of the job flow.
Sets the State property
The value to set for the State property
this instance
Sets the CreationDateTime property
The value to set for the CreationDateTime property
this instance
Sets the StartDateTime property
The value to set for the StartDateTime property
this instance
Sets the ReadyDateTime property
The value to set for the ReadyDateTime property
this instance
Sets the EndDateTime property
The value to set for the EndDateTime property
this instance
Sets the LastStateChangeReason property
The value to set for the LastStateChangeReason property
this instance
The state of the job flow.
Constraints:
-
Allowed Values
COMPLETED, FAILED, TERMINATED, RUNNING, SHUTTING_DOWN, STARTING, WAITING, BOOTSTRAPPING
The creation date and time of the job flow.
The start date and time of the job flow.
The date and time when the job flow was ready to start running
bootstrap actions.
The completion date and time of the job flow.
Description of the job flow last changed state.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Output from an AddInstanceGroups call.
Sets the JobFlowId property
The value to set for the JobFlowId property
this instance
Adds elements to the InstanceGroupIds collection
The values to add to the InstanceGroupIds collection
this instance
The job flow ID in which the instance groups are added.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Instance group IDs of the newly created instance groups.
Container for the parameters to the AddInstanceGroups operation.
AddInstanceGroups adds an instance group to a running
cluster.
Adds elements to the InstanceGroups collection
The values to add to the InstanceGroups collection
this instance
Sets the JobFlowId property
The value to set for the JobFlowId property
this instance
Instance Groups to add.
Job flow in which to add the instance groups.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Response Unmarshaller for DescribeInstanceHealth operation
CreateLoadBalancerResult Unmarshaller
The output for the RegisterInstancesWithLoadBalancer action.
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
An updated list of instances for the LoadBalancer.
The ListenerDescription data type.
Default constructor for a new ListenerDescription object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Sets the Listener property
The value to set for the Listener property
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
The Listener data type.
A list of policies enabled for this listener. An empty list indicates that no policies are enabled.
Interface for accessing AmazonElasticLoadBalancing.
Elastic Load Balancing Elastic Load Balancing is a cost-effective and easy to use web service to help you improve availability and
scalability of your application. It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load
Balancing enables availability through redundancy and supports traffic growth of your application.
Creates a new LoadBalancer. Once the call has completed successfully, a new LoadBalancer is created; however, it will
not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or
not it is usable by using the DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService
.
NOTE: Currently, the client's quota of LoadBalancers is limited to five per Region. NOTE:
Load balancer DNS names vary depending on the Region they're created in. For load balancers created in the United States, the DNS name ends
with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For load
balancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com
Container for the necessary parameters to execute the CreateLoadBalancer service method on
AmazonElasticLoadBalancing.
The response from the CreateLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Deletes listeners from the LoadBalancer for the specified port.
Container for the necessary parameters to execute the DeleteLoadBalancerListeners service
method on AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.
Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the
instances for the LoadBalancer is returned. NOTE: The client must have created the specified input LoadBalancer in
order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.
Container for the necessary parameters to execute the DescribeInstanceHealth service method on
AmazonElasticLoadBalancing.
The response from the DescribeInstanceHealth service method, as returned by AmazonElasticLoadBalancing.
Deletes the specified LoadBalancer. If attempting to recreate the LoadBalancer, the client must reconfigure all the
settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of
the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to client instances. The client
will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created. To successfully call
this API, the client must provide the same account credentials as were used to create the LoadBalancer. NOTE: By
design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds.
Container for the necessary parameters to execute the DeleteLoadBalancer service method on
AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified
expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy,
the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it
first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified
in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the
cookie is based on the cookie expiration time, which is specified in the policy configuration.
Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.
The response from the CreateLBCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.
Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it
will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
Container for the necessary parameters to execute the CreateLoadBalancerListeners service
method on AmazonElasticLoadBalancing.
The response from the CreateLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.
Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns
configuration information for all LoadBalancers created by the caller. NOTE: The client must have created the specified
input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to
create the LoadBalancer.
Container for the necessary parameters to execute the DescribeLoadBalancers service method on
AmazonElasticLoadBalancing.
The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.
Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer. There
must be at least one Availability Zone registered with a LoadBalancer at all times. A client cannot remove all the Availability Zones from a
LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability
Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its
remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide
the same account credentials as those that were used to create the LoadBalancer.
Container for the necessary parameters to execute the
DisableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.
In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be
provided.
Container for the necessary parameters to execute the
DeregisterInstancesFromLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the DeregisterInstancesFromLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be
associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy,
except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in
the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application
cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application
cookie is issued. NOTE: An application client must receive and send two cookies: the application-generated cookie and
the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.
Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.
The response from the CreateAppCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.
Adds new instances to the LoadBalancer. Once the instance is registered, it starts receiving traffic and requests from
the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the
OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same
account credentials as those that were used to create the LoadBalancer. NOTE: Completion of this API does not guarantee
that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.
Container for the necessary parameters to execute the
RegisterInstancesWithLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the RegisterInstancesWithLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior
certificate that was used on the same LoadBalancer and port.
Container for the necessary parameters to execute the
SetLoadBalancerListenerSSLCertificate service method on AmazonElasticLoadBalancing.
The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by AmazonElasticLoadBalancing.
Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.
Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method
on AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.
Associates, updates, or disables a policy with a listener on the load balancer. Currently only zero (0) or one (1) policy can be
associated with a listener.
Container for the necessary parameters to execute the
SetLoadBalancerPoliciesOfListener service method on AmazonElasticLoadBalancing.
The response from the SetLoadBalancerPoliciesOfListener service method, as returned by AmazonElasticLoadBalancing.
Adds one or more EC2 Availability Zones to the LoadBalancer. The LoadBalancer evenly distributes requests across all
its registered Availability Zones that contain instances. As a result, the client must ensure that its LoadBalancer is appropriately scaled
for each registered Availability Zone. NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region
as the Availability Zones for which the LoadBalancer was created.
Container for the necessary parameters to execute the
EnableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Enables the client to define an application healthcheck for the instances.
Container for the necessary parameters to execute the ConfigureHealthCheck service method on
AmazonElasticLoadBalancing.
The response from the ConfigureHealthCheck service method, as returned by AmazonElasticLoadBalancing.
Describes the settings for a configuration set.
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the DeploymentStatus property
The value to set for the DeploymentStatus property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
The name of the solution stack this configuration set uses.
Constraints:
-
Length
0 - 100
The name of the application associated with this configuration set.
Constraints:
-
Length
1 - 100
If not null, the name of the configuration template for this configuration set.
Constraints:
-
Length
1 - 100
Describes this configuration set.
Constraints:
-
Length
0 - 200
If not null, the name of the environment for this configuration set.
Constraints:
-
Length
4 - 23
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this
configuration set: null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the
process of deploying. deployed: This is the configuration that is currently deployed to the
associated running environment. failed: This is a draft configuration, that failed to successfully
deploy. - null: This configuration is not associated with a running environment.
-
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
- deployed: This is the configuration that is currently deployed to the associated running environment.
- failed:
This is a draft configuration that failed to successfully deploy.
Constraints:
-
Allowed Values
deployed, pending, failed
The date (in UTC time) when this configuration set was created.
The date (in UTC time) when this configuration set was last modified.
A list of the configuration options and their values in this configuration set.
Returns information about the UpdateConfigurationTemplateResult response and response metadata.
Gets and sets the UpdateConfigurationTemplateResult property.
Describes the settings for a configuration set.
UpdateApplicationVersionResult Unmarshaller
Update Application Version Request Marshaller
Response Unmarshaller for RequestEnvironmentInfo operation
Response Unmarshaller for DeleteEnvironmentConfiguration operation
CreateConfigurationTemplateResult Unmarshaller
CheckDNSAvailabilityResult Unmarshaller
Container for the parameters to the RetrieveEnvironmentInfo operation.
Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the InfoType property
The value to set for the InfoType property
this instance
The ID of the data's environment. If no such environment is found, returns an InvalidParameterValue error.
The name of the data's environment. If no such environment is found, returns an InvalidParameterValue error.
Constraints:
-
Length
4 - 23
The type of information to retrieve.
Constraints:
-
Allowed Values
tail
A regular expression representing a restriction on a string configuration option value.
Sets the Pattern property
The value to set for the Pattern property
this instance
Sets the Label property
The value to set for the Label property
this instance
The regular expression pattern that a string configuration option value with this restriction must match.
A unique name representing this regular expression.
The description of an Amazon EC2 instance.
Sets the Id property
The value to set for the Id property
this instance
The ID of the Amazon EC2 instance.
Describes an Auto Scaling launch configuration.
Sets the Name property
The value to set for the Name property
this instance
The name of the AutoScalingGroup .
Information returned by the StartInstances
request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if StartInstancesResult property is set
true if StartInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the StartInstancesResult property.
Result of a StartInstances request.
Run Instances Result
Checks if Reservation property is set
true if Reservation property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Reservation property.
Reservation
Reserved Instances Offering
Sets the ReservedInstancesOfferingId property
The ID of the Reserved Instance offering.
this instance
Checks if ReservedInstancesOfferingId property is set
true if ReservedInstancesOfferingId property is set
Sets the InstanceType property
The instance type on which the Reserved
Instance can be used.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the AvailabilityZone property
The Availability Zone in which the Reserved
Instance can be used.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Duration property
The duration of the Reserved Instance, in
seconds.
this instance
Checks if Duration property is set
true if Duration property is set
Sets the UsagePrice property
The usage price of the Reserved Instance, per
hour.
this instance
Checks if UsagePrice property is set
true if UsagePrice property is set
Sets the FixedPrice property
The purchase price of the Reserved Instance.
this instance
Checks if FixedPrice property is set
true if FixedPrice property is set
Sets the ProductDescription property
The Reserved Instance description.
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Checks if InstanceTenancy property is set
true if InstanceTenancy property is set
Sets the InstanceTenancy property
The tenancy of the reserved instance.
this instance
Checks if CurrencyCode property is set
true if InstanceTenancy property is set
Sets the CurrencyCode property
The ISO 4217 CurrencyCode (e.g., USD, JPY).
this instance
Gets and sets the ReservedInstancesOfferingId property.
The ID of the Reserved Instance offering.
Gets and sets the InstanceType property.
The instance type on which the Reserved
Instance can be used.
Gets and sets the AvailabilityZone property.
The Availability Zone in which the Reserved
Instance can be used.
Gets and sets the Duration property.
The duration of the Reserved Instance, in
seconds.
Gets and sets the UsagePrice property.
The usage price of the Reserved Instance, per
hour.
Gets and sets the FixedPrice property.
The purchase price of the Reserved Instance.
Gets and sets the ProductDescription property.
The Reserved Instance description.
Gets and sets the InstanceTenancy property.
The tenancy of the reserved instance.
Gets and sets the CurrencyCode property.
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard (e.g., USD, JPY).
Changes the route table associated with a given subnet in a VPC. After you execute this action, the subnet
uses the routes in the new route table it's associated with. For more information about route tables, go
to Route Tables in the Amazon Virtual Private Cloud User Guide.
Sets the AssociationId property
The ID representing the current association
between the original route table and the
subnet.
this instance
Checks if AssociationId property is set
true if AssociationId property is set
Sets the RouteTableId property
The ID of the new route table to associate with
the subnet.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Gets and sets the AssociationId property.
The ID representing the current association
between the original route table and the
subnet.
Gets and sets the RouteTableId property.
The ID of the new route table to associate with
the subnet.
Register Image Result
Checks if ImageId property is set
true if ImageId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ImageId property.
Unique ID of the newly registered machine
image.
Sets the NetworkAclAssociationId property
An identifier representing the association between a network ACL
and a subnet.
this instance
Checks if NetworkAclAssociationId property is set
true if NetworkAclAssociationId property is set
Sets the NetworkAclId property
The ID of the network ACL in the association.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the SubnetId property
The ID of the subnet in the association.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Gets and sets the NetworkAclAssociationId property.
An identifier representing the association between a network ACL
and a subnet.
Gets and sets the NetworkAclId property.
The ID of the network ACL in the association.
Gets and sets the SubnetId property.
The ID of the subnet in the association.
Adds or remove permission settings for the
specified snapshot
Sets the SnapshotId property
The ID of the snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the Attribute property
Specifies the attribute to modify. Valid
Values: createVolumePermission
this instance
Checks if Attribute property is set
true if Attribute property is set
Sets the OperationType property
Specifies the operation to perform on the
attribute.
Valid Values: add | remove
this instance
Checks if OperationType property is set
true if OperationType property is set
Sets the UserId property
User ID of a user that can create volumes from
the snapshot.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the UserGroup property
Group that is allowed to create volumes from
the snapshot (currently
supports "all").
this instance
Checks if UserGroup property is set
true if UserGroup property is set
Gets and sets the SnapshotId property.
The ID of the snapshot.
Gets and sets the Attribute property.
Specifies the attribute to modify. Valid
Values: createVolumePermission
Gets and sets the OperationType property.
Specifies the operation to perform on the
attribute.
Valid Values: add | remove
Gets and sets the UserId property.
User ID of a user that can create volumes from
the snapshot.
Gets and sets the UserGroup property.
Group that is allowed to create volumes from
the snapshot (currently
supports "all").
Sets the BytesConverted property
Number of bytes converted so far.
this instance
Checks if BytesConverted property is set
true if BytesConverted property is set
Sets the AvailabilityZone property
The Availability Zone where the resulting instance will reside.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Image property
Information about the image.
this instance
Checks if Image property is set
true if Image property is set
Sets the Description property
Description you provided when starting the import instance task.
this instance
Checks if Description property is set
true if Description property is set
Sets the Volume property
Information about the volume.
this instance
Checks if Volume property is set
true if Volume property is set
Sets the Status property
Status of the import of this particular disk image.
this instance
Checks if Status property is set
true if Status property is set
Sets the StatusMessage property
Status information or errors related to the disk image.
this instance
Checks if StatusMessage property is set
true if StatusMessage property is set
Gets and sets the BytesConverted property.
Number of bytes converted so far.
Gets and sets the AvailabilityZone property.
The Availability Zone where the resulting instance will reside.
Gets and sets the Image property.
Information about the image.
Gets and sets the Description property.
Description you provided when starting the import instance task.
Gets and sets the Volume property.
Information about the volume.
Gets and sets the Status property.
Status of the import of this particular disk image.
Gets and sets the StatusMessage property.
Status information or errors related to the disk image.
Describe Vpn Gateways Result
Checks if VpnGateway property is set
true if VpnGateway property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the VpnGateway property.
List of VPN gateways
Describe Vpn Gateways Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeVpnGatewaysResult property is set
true if DescribeVpnGatewaysResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeVpnGatewaysResult property.
Describe Vpn Gateways Result
Gives you information about your VPN connections.
Important - we strongly recommend you use HTTPS when calling this
operation because the response contains sensitive cryptographic
information for configuring your customer gateway.
You can filter the results to return information only about VPN
connections that match criteria you specify.
For example, you could ask to get information about a particular VPN
connection (or all) only if the VPN's state is pending or available.
You can specify multiple filters (e.g., the VPN connection is
associated with a particular VPN gateway, and
the gateway's state is pending or available).
The result includes information for a particular VPN connection
only if the VPN connection matches all your filters.
If there's no match, no special message is returned; the response is
simply empty.
The returned information consists of:
1. The VPN connection ID.
2. The type of connection.
3. Customer gateway ID.
4. VPN gateway ID.
5. The current state of the VPN connection (pending, available,
deleting, deleted).
6. The customer gateway configuration information in the
native XML format.
Sets the VpnConnectionId property
A VPN connection ID
this instance
Checks if VpnConnectionId property is set
true if VpnConnectionId property is set
Sets the Filter property
The filter to apply on the results of DescribeVpnConnections.
Filters can be:
a. state - The state of the VPN connection. (pending, available,
deleting, deleted).
b. type - The type of VPN connection. Currently the only
supported type is ipsec.1.
c. customerGatewayId - The ID of a customer gateway associated
with the VPN connection.
d. vpnGatewayId - The ID of a VPN gateway associated with the VPN
connection.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the VpnConnectionId property.
A VPN connection ID
Gets and sets the Filter property.
The filter to apply on the results of DescribeVpnConnections.
Filters can be:
a. state - The state of the VPN connection. (pending, available,
deleting, deleted).
b. type - The type of VPN connection. Currently the only
supported type is ipsec.1.
c. customerGatewayId - The ID of a customer gateway associated
with the VPN connection.
d. vpnGatewayId - The ID of a VPN gateway associated with the VPN
connection.
Checks if PlacementGroupInfo property is set
true if PlacementGroupInfo property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the PlacementGroupInfo property.
Contains information about the specified
PlacementGroups.
Returns information about one or more
PlacementGroup instances
in a user's account.
Sets the GroupName property
The name of the PlacementGroup.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with the
specified PlacementGroups.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the GroupName property.
The name of the PlacementGroup.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with the
specified PlacementGroups.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Provides details of a user's registered licenses.
Zero or more IDs may be specified on the call.
When one or more license IDs are specified,
only data for the specified IDs are returned.
Sets the LicenseId property
Specifies the license registration for which
details are to be returned.
this instance
Checks if LicenseId property is set
true if LicenseId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags
associated with the specified Licenses.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the LicenseId property.
Specifies the license registration for which
details are to be returned.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags
associated with the specified Licenses.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Gives you information about one or more sets of DHCP options. You can
specify one or more DHCP options set IDs, or no IDs (to describe
all your sets of DHCP options). The returned information consists of:
1. The DHCP options set ID
2. The options
Sets the DhcpOptionsId property
A DHCP options set ID.
this instance
Checks if DhcpOptionsId property is set
true if DhcpOptionsId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with the specified
DhcpOptions.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the DhcpOptionsId property.
A DHCP options set ID.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with the specified
DhcpOptions.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describes current bundling tasks. For more
information on bundling
instances, go to the
Amazon Elastic Compute
Cloud Developer Guide or Amazon Elastic Compute
Cloud Getting Started Guide.
Sets the BundleId property
The ID of the bundle task to describe.
this instance
Checks if BundleId property is set
true if BundleId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified BundleTasks.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the BundleId property.
The ID of the bundle task to describe.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified BundleTasks.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Availability Zones Result
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the AvailabilityZone property.
Availability Zone information.
Deletes a VPC. You must terminate all running instances and delete
all subnets before deleting the VPC, otherwise Amazon VPC returns an error.
AWS might delete any VPC if you leave it inactive for an extended
period of time (inactive means that there are no running Amazon EC2 instances in the VPC).
Sets the VpcId property
The ID of the VPC you want to delete.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the VpcId property.
The ID of the VPC you want to delete.
Deletes a route from a route table in a VPC. For more information about route tables, go to Route Tables
in the Amazon Virtual Private Cloud User Guide.
Sets the RouteTableId property
The ID of the route table where the route will
be deleted.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the DestinationCidrBlock property
The CIDR range for the route you want to
delete. The value you specify must exactly
match the CIDR for the route you want to
delete.
this instance
Checks if DestinationCidrBlock property is set
true if DestinationCidrBlock property is set
Gets and sets the RouteTableId property.
The ID of the route table where the route will
be deleted.
Gets and sets the DestinationCidrBlock property.
The CIDR range for the route you want to
delete. The value you specify must exactly
match the CIDR for the route you want to
delete.
The Response for the
DeleteNetworkAclEntry operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
The Response for the
DeleteInternetGateway operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Vpn Connection Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateVpnConnectionResult property is set
true if CreateVpnConnectionResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateVpnConnectionResult property.
Create Vpn Connection Result
CreateRouteTable Result
Checks if RouteTable property is set
true if RouteTable property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the RouteTable property.
Information about the newly created route table.
The Response for the
CreateRouteTable operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateRouteTableResult property is set
true if CreateRouteTableResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateRouteTableResult property.
CreateRouteTable Result
Create Dhcp Options Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateDhcpOptionsResult property is set
true if CreateDhcpOptionsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateDhcpOptionsResult property.
Create Dhcp Options Result
CancelBundleTaskResponse
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CancelBundleTaskResult property is set
true if CancelBundleTaskResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CancelBundleTaskResult property.
Cancel Bundle Task Result
If the task fails, a description of the error.
Sets the Code property
Error code.
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
Error message.
this instance
Checks if Message property is set
true if Message property is set
Gets and sets the Code property.
Error code.
Gets and sets the Message property.
Error message.
DescribeAlarmsForMetricResult Unmarshaller
Describe Alarm History Request Marshaller
Datapoint Unmarshaller
AlarmHistoryItem Unmarshaller
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. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action. The size of
a PutMetricData request is limited to 8 KB for HTTP GET requests and
40 KB for HTTP POST requests. IMPORTANT: Although
the Value parameter accepts numbers of type Double, Amazon CloudWatch
truncates values with very large exponents. Values with base-10
exponents greater than 126 (1 x 10^126) are truncated. Likewise,
values with base-10 exponents less than -130 (1 x 10^-130) are also
truncated.
Sets the Namespace property
The value to set for the Namespace property
this instance
Adds elements to the MetricData collection
The values to add to the MetricData collection
this instance
Adds elements to the MetricData collection
The values to add to the MetricData collection
this instance
The namespace for the metric data.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
A list of data describing the metric.
AmazonCloudWatch exception
Constructs a new InvalidParameterCombinationException with the specified error
message.
Describes the error encountered.
The ListStreamingDistributionsResponse contains the ListStreamingDistributionsResult and
any headers or metadata returned by CloudFront.
Gets the StreamingDistribution property as a List
Gets and sets the Marker property.
Gets and sets the MaxItems property.
Gets and sets the NextMarker property.
Gets and sets the IsTruncated property.
The GetDistributionInfoRequest contains the parameters used for the GetDistributionInfo operation.
Required Parameter: Id
Sets the Id property of this request to the value passed in.
The distribution's id
The request with the Id property set
Gets and sets the Id property for the Distribution
This response contains any headers and the CloudFrontOriginAccessIdentity Config
for the CloudFront Origin Access Identity created.
Gets and sets the OriginAccessIdentity property.
Gets and sets the Location property.
Gets and sets the ETag property.
The Origin Access Identity's ETag is also set if
possible.
Validate Template Request Marshaller
Stack Unmarshaller
Describe Stack Resources Request Marshaller
Returns information about the DescribeStackResourceResult response and response metadata.
Gets and sets the DescribeStackResourceResult property.
The output for a DescribeStackResource action.
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
DescribeStacks API if the deletion has been completed successfully.
Sets the StackName property
The value to set for the StackName property
this instance
The name or the unique identifier associated with the stack.
Response Unmarshaller for SetDesiredCapacity operation
Set Desired Capacity Request Marshaller
Returns information about the TerminateInstanceInAutoScalingGroupResult response and response metadata.
Gets and sets the TerminateInstanceInAutoScalingGroupResult property.
The output for the TerminateInstanceInAutoScalingGroup action.
The MetricCollectionType data type.
Sets the Metric property
The value to set for the Metric property
this instance
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The AutoScalingInstancesType data type.
Adds elements to the AutoScalingInstances collection
The values to add to the AutoScalingInstances collection
this instance
Adds elements to the AutoScalingInstances collection
The values to add to the AutoScalingInstances collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of Auto Scaling instances.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Information returned by the ListQueuesRequest, including queue URL.
Checks if QueueUrl property is set
true if QueueUrl property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Returns a list of queues and related metadata about the request.
Checks if ListQueuesResult property is set
true if ListQueuesResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ListQueuesResult property.
Information returned by the ListQueuesRequest, including queue URL.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Allows a topic owner to set a topic's attributes.
Sets the TopicArn property
The Amazon Reference Name (ARN) of the topic the client wishes
to set the attribute value of.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the AttributeName property
The name of the attribute the client wishes to set.
Only a subset of a topic's attributes can be set.
this instance
Checks if AttributeName property is set
true if AttributeName property is set
Sets the AttributeValue property
The value of the attribute the client wishes to set.
this instance
Checks if AttributeValue property is set
true if AttributeValue property is set
Gets and sets the TopicArn property.
The Amazon Reference Name (ARN) of the topic the client wishes
to set the attribute value of.
Gets and sets the AttributeName property.
The name of the attribute the client wishes to set.
Only a subset of a topic's attributes can be set.
Gets and sets the AttributeValue property.
The value of the attribute the client wishes to set.
Configuration for accessing Amazon Simple Notification Service service
Sets the SignatureMethod property
SignatureMethod property
this instance
Checks if SignatureMethod property is set
true if SignatureMethod property is set
Sets the SignatureVersion property
SignatureVersion property
this instance
Checks if SignatureVersion property is set
true if SignatureVersion property is set
Sets the UserAgent property
UserAgent property
this instance
Checks if UserAgent property is set
true if UserAgent property is set
Sets the ServiceURL property
ServiceURL property
this instance
Checks if ServiceURL property is set
true if ServiceURL property is set
Sets the ProxyHost property
ProxyHost property
this instance
Checks if ProxyHost property is set
true if ProxyHost property is set
Sets the ProxyPort property
ProxyPort property
this instance
Checks if ProxyPort property is set
true if ProxyPort property is set
Sets the MaxErrorRetry property
MaxErrorRetry property
this instance
Checks if MaxErrorRetry property is set
true if MaxErrorRetry property is set
Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Whether a secure string should be used or not.
The Config object with the property set
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Sets the ProxyUsername property
Value for the ProxyUsername property
this instance
Checks if ProxyUsername property is set
true if ProxyUsername property is set
Sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
ProxyPassword property
this instance
Checks if ProxyPassword property is set
true if ProxyPassword property is set
Gets Service Version
Gets and sets of the signatureMethod property.
Gets and sets of the SignatureVersion property.
Gets and sets of the UserAgent property.
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint or want to switch between https and http.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureStringForAwsSecretKey property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
Response Unmarshaller for GetSendStatistics operation
Get Send Quota Request Marshaller
Returns information about the GetSendStatisticsResult response and response metadata.
Gets and sets the GetSendStatisticsResult property.
Represents a list of SendDataPoint items returned from a successful GetSendStatistics request. This list contains aggregated data from the
previous two weeks of sending activity.
Represents textual data, plus an optional character set
specification. By default, the text must be 7-bit ASCII,
due to the constraints of the SMTP protocol. If the text must contain
any other characters, then you must also specify a character set.
Examples include UTF-8, ISO-8859-1, and Shift_JIS.
Default constructor for a new Content object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Content object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The textual data of the content.
Sets the Data property
The value to set for the Data property
this instance
Sets the Charset property
The value to set for the Charset property
this instance
The textual data of the content.
The character set of the content.
Implemenation for accessing AmazonSimpleEmailService.
Amazon Simple Email Service This is the API Reference for
Amazon Simple Email Service (Amazon SES). This documentation is
intended to be used in conjunction with the Amazon SES Getting Started
Guide and the Amazon SES Developer Guide. For specific
details on how to construct a service request, please consult the
Amazon SES Developer Guide.
Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonSimpleEmailServiceClient Configuration Object
Returns the user's current activity limits.
Container for the necessary
parameters to execute the GetSendQuota service method on
AmazonSimpleEmailService.
The response from the GetSendQuota service method, as
returned by AmazonSimpleEmailService.
Returns a list containing all of the email addresses that have
been verified.
Container for the
necessary parameters to execute the ListVerifiedEmailAddresses service
method on AmazonSimpleEmailService.
The response from the ListVerifiedEmailAddresses service
method, as returned by AmazonSimpleEmailService.
Returns the user's sending statistics. The result is a list of
data points, representing the last two weeks of sending
activity. Each data point in the list contains statistics
for a 15-minute interval.
Container for the necessary
parameters to execute the GetSendStatistics service method on
AmazonSimpleEmailService.
The response from the GetSendStatistics service method, as
returned by AmazonSimpleEmailService.
Composes an email message, based on input data, and then
immediately queues the message for sending.
Container for the necessary parameters
to execute the SendEmail service method on
AmazonSimpleEmailService.
The response from the SendEmail service method, as returned
by AmazonSimpleEmailService.
Deletes the specified email address from the list of verified
addresses.
Container for the
necessary parameters to execute the DeleteVerifiedEmailAddress service
method on AmazonSimpleEmailService.
Verifies an email address. This action causes a confirmation
email message to be sent to the specified address.
Container for the necessary
parameters to execute the VerifyEmailAddress service method on
AmazonSimpleEmailService.
Sends an email message, with header and content specified by the
client. The SendRawEmail action is useful for sending multipart
MIME emails, with attachments or inline content. The raw
text of the message must comply with Internet email standards;
otherwise, the message cannot be sent. For more information, go to
the Amazon SES Developer Guide.
Container for the necessary
parameters to execute the SendRawEmail service method on
AmazonSimpleEmailService.
The response from the SendRawEmail service method, as
returned by AmazonSimpleEmailService.
Lists all domains associated with the account. It returns domain names up to the limit set by MaxNumberOfDomains.
A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times
with the NextToken returns up to MaxNumberOfDomains more domain names each time.
Sets the MaxNumberOfDomains property
The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.
this instance
Checks if MaxNumberOfDomains property is set
true if MaxNumberOfDomains property is set
Sets the NextToken property
String that tells Amazon SimpleDB where to start the next list of domain names.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the MaxNumberOfDomains property.
The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.
Gets and sets the NextToken property.
String that tells Amazon SimpleDB where to start the next list of domain names.
Provides configuration options for how processes requests.
The best configuration settings depend on network
configuration, latency and bandwidth.
The default configuration settings are suitable
for most applications, but this class enables developers to experiment with
different configurations and tune transfer manager performance.
Default constructor.
Gets or sets the minimum part size for upload parts.
Decreasing the minimum part size causes
multipart uploads to be split into a larger number
of smaller parts. Setting this value too low has a negative effect
on transfer speeds, causing extra latency and network
communication for each part.
Gets or sets the number of executing threads.
This property determines how many active threads will be used to upload
the file. The default value is 10 threads.
If this property is set to a value greater then than
will be updated to the value. If simultaneous uploads are being
done then consider increasing the property.
A value less than or equal to 0 will be silently ignored.
Gets or sets the default timeout in milliseconds used for writing objects to S3. The default value is 5 minutes.
Provides a high level utility for managing transfers to and from Amazon S3.
TransferUtility provides a simple API for
uploading content to and downloading content
from Amazon S3, and makes extensive use of Amazon S3 multipart uploads to
achieve enhanced throughput, performance and reliability.
When uploading large files by specifing files path as opposed to a stream, TransferUtility uses multiple threads to upload
multiple parts of a single upload at once. When dealing with large content
sizes and high bandwidth, this can have a significant increase on throughput.
The TransferUtility checks to make sure that
is equal to or greater than . If
it is not then it will update to the same value as
. If simultaneous uploads are being
done then consider increasing the property.
Transfers are stored in memory. If the application is restarted,
previous transfers are no longer accessible. If needed, clean up any multipart uploads
that are incomplete.
Constructs a new class.
The AWS Access Key ID.
The AWS Secret Access Key.
Constructs a new instance of the class.
The AWS Access Key ID.
The AWS Secret Access Key.
The config for setting advances settings.
Constructs a new instance of the class.
The Amazon S3 client.
Initializes a new instance of the class.
The Amazon S3 client.
The advanced configuration settings for .
Disposes resources and performs initiates garbage collection
for the class.
Initiates the asynchronous execution of the UploadDirectory operation.
The directory containing files to upload.
The name of the bucket to upload files to.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUploadDirectory.
Uploads the files in directory. The object key is obtained from the file names
inside the directory.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The directory containing files to upload.
The name of the bucket to upload files to.
Initiates the asynchronous execution of the UploadDirectory operation.
The directory containing files to upload.
The name of the bucket to upload files to.
The pattern used to find files to upload in the directory.
The search option specifying whether or not to recursively search for files to upload
in subdirectories or not.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUploadDirectory.
Uploads the files in directory. The object key is obtained from the file names
inside the directory.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The directory containing files to upload.
The name of the bucket to upload files to.
The pattern used to find files to upload in the directory.
The search option specifying whether or not to recursively search for files to upload
in subdirectories or not.
Initiates the asynchronous execution of the UploadDirectory operation.
The request that contains all the parameters to upload a directory.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUploadDirectory.
Finishes the asynchronous execution of the UploadDirectory operation.
The IAsyncResult returned by the call to BeginUploadDirectory.
Uploads the files in directory. The object key is obtained from the file names
inside the directory.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The request that contains all the parameters to upload a directory.
Initiates the asynchronous execution of the Upload operation.
The file path of the file to upload.
The name of the bucket to upload the file to.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUpload.
Uploads the specified file.
The object key is obtained from the file's file name.
Multiple threads are used to read the file and perform multiple uploads in parallel.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The file path of the file to upload.
The name of the bucket to upload the file to.
Initiates the asynchronous execution of the Upload operation.
The file path of the file to upload.
The name of the bucket to upload the file to.
The key under which the Amazon S3 object is stored.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUpload.
Uploads the specified file.
Multiple threads are used to read the file and perform multiple uploads in parallel.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The file path of the file to upload.
The name of the bucket to upload the file to.
The key under which the Amazon S3 object is stored.
Initiates the asynchronous execution of the Upload operation.
The stream to read to the content of the object.
The name of the bucket to upload the stream to.
The key under which the Amazon S3 object is stored.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUpload.
Uploads the contents of the specified stream.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
The stream to read to the content of the object.
The name of the bucket to upload the stream to.
The key under which the Amazon S3 object is stored.
Initiates the asynchronous execution of the Upload operation.
Contains all the parameters used for uploading to Amazon S3.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndUpload.
Finishes the asynchronous execution of the Upload operation.
The IAsyncResult returned by the call to BeginUpload.
Uploads the file or stream specified by the request.
To track the progress of the upload,
add an event listener to the request's UploadProgressEvent.
For large uploads, the file will be divided and uploaded in parts using
Amazon S3's multipart API. The parts will be reassembled as one object in
Amazon S3.
Contains all the parameters used for uploading to Amazon S3.
Initiates the asynchronous execution of the OpenStream operation.
The name of the bucket.
The object key.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndOpenStream.
Returns a stream to read the contents from Amazon S3 as
specified by bucket name and key.
The caller of this method is responsible for closing the stream.
The name of the bucket.
The object key.
A stream containing contents returned from Amazon S3.
Initiates the asynchronous execution of the OpenStream operation.
Contains all the parameters used for opening a stream to an S3 object.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndOpenStream.
Returns a stream to read the contents from Amazon S3 as
specified by the TransferUtilityOpenStreamRequest.
The caller of this method is responsible for closing the stream.
Contains all the parameters used for opening a stream to an S3 object.
A stream containing contents returned from Amazon S3.
Initiates the asynchronous execution of the Download operation.
The file path where the content from Amazon S3 will be written to.
The name of the bucket containing the Amazon S3 object to download.
The key under which the Amazon S3 object is stored.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDownload.
Downloads the content from Amazon S3 and writes it to the specified file.
The object key is obtained from the file's file name.
The file path where the content from Amazon S3 will be written to.
The name of the bucket containing the Amazon S3 object to download.
The key under which the Amazon S3 object is stored.
Initiates the asynchronous execution of the Download operation.
Contains all the parameters used to download an Amazon S3 object.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndDownload.
Downloads the content from Amazon S3 and writes it to the specified file.
If the key is not specified in the request parameter,
the file name will be assumed.
Contains all the parameters used to download an Amazon S3 object.
Finishes the asynchronous execution of the Download operation.
The IAsyncResult returned by the call to BeginDownload.
Initiates the asynchronous execution of the AbortMultipartUploads operation.
The name of the bucket containing multipart uploads.
The date before which the multipart uploads were initiated.
An AsyncCallback delegate that is invoked when the operation completes.
A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.
An IAsyncResult that can be used to poll or wait for results, or both;
this value is also needed when invoking EndAbortMultipartUploads.
Finishes the asynchronous execution of the AbortMultipartUploads operation.
The IAsyncResult returned by the call to BeginAbortMultipartUploads.
Aborts the multipart uploads that were initiated before the specified date.
The name of the bucket containing multipart uploads.
The date before which the multipart uploads were initiated.
Gets the Amazon S3 client used for making calls into Amazon S3.
The Amazon S3 client used for making calls into Amazon S3.
Properties that define the website configuration for a S3 bucket.
Sets the IndexDocumentSuffix property for this request.
This value is a suffix that is appended to a request that is for a "directory"
on the website endpoint (e.g. if the suffix is index.html and
you make a request to samplebucket/images/ the data that
is returned will be for the object with the key name
images/index.html)
The suffix must not be empty and must not include a slash
character.
The value that IndexDocumentSuffix is set to
the WebsiteConfiguration with the IndexDocumentSuffix set
Checks if IndexDocumentSuffix property is set.
true if IndexDocumentSuffix property is set.
Sets the ErrorDocument property for this request.
The object key name to use when a 4XX class error occurs
The value that ErrorDocument is set to
the WebsiteConfiguration with the ErrorDocument set
Checks if ErrorDocument property is set.
true if ErrorDocument property is set.
Gets and sets the IndexDocumentSuffix property.
This value is a suffix that is appended to a request that is for a "directory"
on the website endpoint (e.g. if the suffix is index.html and
you make a request to samplebucket/images/ the data that
is returned will be for the object with the key name
images/index.html)
The suffix must not be empty and must not include a slash
character.
Gets and sets the ErrorDocument property.
The object key name to use when a 4XX class error occurs
The GetObjectMetadataResponse contains any headers returned by S3.
Gets and sets the lastModified property.
Gets and sets the ETag property.
Gets and sets the ContentType property.
Gets and sets the ContentLength property.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
The GetBucketLocationResponse contains the GetBucketLocationResult and
any headers returned by S3.
Gets and sets the Location property.
The DeleteBucketResponse contains any headers returned by S3.
The PutBucketPolicyRequest contains the parameters used for the PutBucketPolicy operation.
Required Parameters: BucketName, Policy
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Policy property for this request.
This is the JSON string representing the policy that will be applied to the S3 Bucket.
The JSON string for the policy
this instance
Checks if policy property is set.
true if Policy property is set.
Gets and sets the BucketName property.
Gets and sets the Policy property.
The ListPartsResponse contains all the information about the
ListParts method.
Gets and sets the name of the bucket to which the multipart upload was initiated.
Gets and sets the object key for which the multipart upload was initiated.
Gets and sets the upload ID identifying the multipart upload whose parts are being listed.
Gets and sets the Owner property.
Gets and sets the Initiator property.
Gets and sets the class of storage used to store the uploaded object.
Gets and sets the part number after which listing begins.
Gets and sets the NextPartNumberMarker property.
When a list is truncated, specifies the last part that should be skipped
over to resume listing. Use this value for the PartNumberMarker
request property in a subsequent request.
Gets and sets the maximum number of parts allowed in a response.
Gets and sets the IsTruncated property.
Indicates whether the returned list of parts is truncated. A value true
indicates the list was truncated. A list may be truncated if the number of
parts exceeds the limit specified by MaxParts.
Gets and sets the Parts property.
PartDetails is a container for elements related to a particular part. A response can contain
zero or more Part elements.
The ListPartsRequest contains the parameters used for the ListParts method.
Required Parameters: BucketName, Key, UploadId
Sets the BucketName property for this request.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the UploadId property for this request.
This is the upload id for the multipart upload in process.
The value that Key is set to
the request with the Key set
Checks if UploadId property is set.
true if UploadId property is set.
Sets the MaxParts property for this request.
The value that MaxParts is set to
the request with the MaxParts set
Checks if MaxParts property is set.
true if MaxParts property is set.
Sets the Key property for this request.
The value that PartNumberMarker is set to
the request with the PartNumberMarker set
Checks if PartNumberMarker property is set.
true if PartNumberMarker property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the UploadId property.
This is the upload id for the multipart upload in process.
Gets and sets the MaxParts property.
Gets and sets the PartNumberMarker property.
Specifies the part after which listing should begin. Only parts with higher
part numbers will be listed.
The GetBucketVersioningRequest contains the parameters used for the GetBucketVersioning operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
The CopyPartResponse contains all the information about the
CopyPart operation.
Gets and sets the LastModified property.
Gets and sets the ETag property.
Gets and sets the SourceVersionId property.
This is the Version Id of the Source Object
Gets and sets the PartNumber property.
This is the part number in it's multi-part upload that will uniquely identify the part
and determine the relative ordering within the destination object.
Gets and sets the Headers property.
The CopyPartRequest contains the parameters used for the CopyPart operation.
Required Parameters: SourceBucket, SourceKey, DestinationBucket, DestinationKey,
UploadID, PartNumber
Optional Parameters: ETagsToMatch, ETagsToNotMatch, ModifiedSinceDate,
UnmodifiedSinceDate, Timeout, SourceVersionId, FirstByte, LastByte
Sets the SourceBucket property for this request.
This is the S3Bucket that contains the S3 Object you
want to copy.
The value that SourceBucket is set to
the request with the SourceBucket set
Checks if SourceBucket property is set.
true if SourceBucket property is set.
Sets the SourceKey property for this request.
This is the S3Object you want to copy.
The value that SourceKey is set to
the request with the SourceKey set
Checks if SourceKey property is set.
true if SourceKey property is set.
Sets the SourceVersionId property for this request.
This is the SourceVersionId for the S3 Object you want to Get.
The value that SourceVersionId is set to
this instance
Checks if SourceVersionId property is set.
true if SourceVersionId property is set.
Sets the DestinationBucket property for this request.
This is the S3 Bucket where the copied S3 Object is put.
The value that DestinationBucket is set to
the request with the DestinationBucket set
Checks if DestinationBucket property is set.
true if DestinationBucket property is set.
Sets the DestinationKey property for this request.
This is the key for the new S3 Object that is copied.
The value that DestinationKey is set to
the request with the Destinationkey set
Checks if DestinationKey property is set.
true if DestinationKey property is set.
Sets the UploadID property for this request.
This is the ID of the multipart upload for which we are copying a part.
The value that UploadID is set to
the request with the UploadID set
Checks if UploadID property is set.
true if UploadID property is set.
Adds the Etags to the ETagsToMatch property for this request.
Copies the object if its entity tag (ETag) matches
one of the specified tag; otherwise return a 412 (precondition failed).
The items to be added to the ETagsToMatch.
this instance
Adds the Etags to the ETagsToMatch property for this request.
Copies the object if its entity tag (ETag) matches
one of the specified tag; otherwise return a 412 (precondition failed).
The items to be added to the ETagsToMatch.
this instance
Checks if ETagsToMatch property is set.
true if ETagToMatch property is set.
Adds the Etags to the ETagsToNotMatch property for this request.
Copies the object if its entity tag (ETag) is different
from all the specified Etags; otherwise returns a 412 (failed condition).
The ETags to add to the ETagsToNotMatch property
this instance
Adds the Etags to the ETagsToNotMatch property for this request.
Copies the object if its entity tag (ETag) is different
from all the specified Etags; otherwise returns a 412 (failed condition).
The ETags to add to the ETagsToNotMatch property
this instance
Checks if ETagToNotMatch property is set.
true if ETagToNotMatch property is set.
Sets the ModifiedSinceDate property for this request.
Copies the object if it has been modified since the
specified time; otherwise returns a 412 (failed condition).
The value that ModifiedSinceDate is set to
this instance
Checks if ModifiedSinceDate property is set.
true if ModifiedSinceDate property is set.
Sets the UnmodifiedSinceDate property for this request.
Copies the object if it hasn't been modified since the
specified time; otherwise returns a 412 (precondition failed).
The value that UnmodifiedSinceDate is set to
this instance
Checks if UnmodifiedSinceDate property is set.
true if UnmodifiedSinceDate property is set.
Sets the Timeout property (in milliseconds).
Please set the timeout only if you are certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
Timeout property
Attempting to set value less than or equal to 0 (and not Infinite)
will be silently ignored
this instance
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
ReadWriteTimeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets of the PartNumber property.
Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part
and determine the relative ordering within the destination object. If a part already
exists with the PartNumber it will be overwritten.
value to set the PartNumber property to
this instance
Checks if PartNumber property is set.
true if PartNumber property is set.
Sets the firstByte property. This property contains the location of the first
byte in the range if only a portion of the source object is to be copied as the part.
The LastByte property must also be set or this value will be ignored.
The value to set the FirstByte property too
this instance
Checks if FirstByte property is set.
true if FirstByte property is set.
Gets and sets the lastByte property. This property contains the location of the last
byte in the range if only a portion of the source object is to be copied as the part.
The FirstByte property must also be set or this value will be ignored.
The value to set the LastByte property to
this instance
Checks if LastByte property is set.
true if LastByte property is set.
Gets and sets the SourceBucket property.
Gets and sets the SourceKey property.
Gets and sets the SourceVersionId property.
Gets and sets the DestinationBucket property.
Gets and sets the DestinationKey property.
Gets and sets the UploadID property.
Gets and sets the ETagsToMatch property.
Gets and sets the ETagsToNotMatch property.
Gets and sets the ModifiedSinceDate property.
Gets and sets the UnmodifiedSinceDate property.
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for S3 COPY requests.
Attempting to set value less than or equal to 0 (and not Infinite)
will be silently ignored
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout properties of the
HTTPWebRequest object used for S3 COPY requests.
A value less than or equal to 0 will be silently ignored
Gets and sets of the PartNumber property.
Valid part numbers are from 1 to 10,000 inclusive and will uniquely identify the part
and determine the relative ordering within the destination object. If a part already
exists with the PartNumber it will be overwritten.
Gets and sets the firstByte property. This property contains the location of the first
byte in the range if only a portion of the source object is to be copied as the part.
The LastByte property must also be set or this value will be ignored.
Gets and sets the lastByte property. This property contains the location of the last
byte in the range if only a portion of the source object is to be copied as the part.
The FirstByte property must also be set or this value will be ignored.
Result Unmarshaller for ModifyDBInstance operation
Describe D B Security Groups Request Marshaller
Result Unmarshaller for DeleteDBInstance operation
DBSecurityGroupMembership Unmarshaller
Result Unmarshaller for CreateDBParameterGroup operation
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
The name of the DB Parameter Group.
Container for the parameters to the ResetDBParameterGroup operation.
Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the
following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to
take effect on the next DB instance restart or RebootDBInstance request.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the ResetAllParameters property
The value to set for the ResetAllParameters property
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
The name of the DB Parameter Group. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a
letter
- Cannot end with a hyphen or contain two consecutive hyphens
Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values. Default:
true
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method
must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. MySQL Valid
Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can
use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots. Oracle
Valid Values (for Apply method): pending-reboot
AmazonRDS exception
Constructs a new ReservedDBInstanceAlreadyExistsException with the specified error
message.
Describes the error encountered.
Container for the parameters to the DescribeOrderableDBInstanceOptions operation.
Returns a list of orderable DB Instance options for the specified engine.
Sets the Engine property
The value to set for the Engine property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The name of the engine to retrieve DB Instance options for.
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords .
Contains the result of a successful invocation of the DescribeEvents action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the Events collection
The values to add to the Events collection
this instance
Adds elements to the Events collection
The values to add to the Events collection
this instance
The marker obtained from a previous operation response.
A list of Event instances.
Contains the result of a successful invocation of the DescribeDBParameters action.
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of Parameter instances.
The marker obtained from a previous operation response.
Returns information about the CreateDBInstanceReadReplica response and response metadata.
Gets and sets the CreateDBInstanceReadReplicaResult property.
Contains the result of a successful invocation of the CreateDBInstanceReadReplica
action.
AmazonImportExport exception
Constructs a new MissingManifestFieldException with the specified error
message.
Describes the error encountered.
Container for the parameters to the ListJobs operation.
This operation returns the jobs associated with the requester.
AWS Import/Export lists the jobs in reverse chronological order based
on the date of creation. For example if Job Test1 was created
2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation
would return Test2 followed by Test1.
Sets the MaxJobs property
The value to set for the MaxJobs property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the maximum number of jobs returned in the response. If there are
additional jobs that were not returned because MaxJobs was exceeded,
the response contains true. To return the
additional jobs, see Marker.
Specifies the JOBID to start after when listing the jobs created with
your account. AWS Import/Export lists your jobs in reverse
chronological order. See MaxJobs.
Contains the result of a successful invocation of the
UploadSigningCertificate action.
Sets the Certificate property
The value to set for the Certificate property
this instance
Information about the certificate.
Container for the parameters to the UploadServerCertificate operation.
Uploads a server certificate entity for the AWS Account. The
server certificate entity includes a public key certificate, a private
key, and an optional certificate chain, which should all be
PEM-encoded. For information about the number of server
certificates you can upload, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
NOTE:Because the body of the public key certificate,
private key, and the certificate chain can be large, you should use
POST rather than GET when calling UploadServerCertificate. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Sets the Path property
The value to set for the Path property
this instance
Sets the ServerCertificateName property
The value to set for the ServerCertificateName property
this instance
Sets the CertificateBody property
The value to set for the CertificateBody property
this instance
Sets the PrivateKey property
The value to set for the PrivateKey property
this instance
Sets the CertificateChain property
The value to set for the CertificateChain property
this instance
The path for the server certificate. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management. This parameter is optional. If it is not included, it defaults to a slash
(/).
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
The name for the server certificate. Do not include the path in this value.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The contents of the public key certificate in PEM-encoded format.
Constraints:
-
Length
1 - 16384
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
The contents of the private key in PEM-encoded format.
Constraints:
-
Length
1 - 16384
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]*
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
Constraints:
-
Length
1 - 2097152
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]*
Returns information about the UpdateServerCertificate response metadata.
The UpdateServerCertificate operation has a void result type.
Returns information about the UpdateLoginProfile response metadata.
The UpdateLoginProfile operation has a void result type.
SigningCertificate Unmarshaller
ServerCertificateMetadata Unmarshaller
List Server Certificates Request Marshaller
List M F A Devices Request Marshaller
List Groups For User Request Marshaller
ListAccountAliasesResult Unmarshaller
AccessKeyMetadata Unmarshaller
Container for the parameters to the ListServerCertificates operation.
Lists the server certificates that have the specified path
prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Sets the PathPrefix property
The value to set for the PathPrefix property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path
starts with /company/servercerts. This parameter is optional. If it is not included, it defaults to a slash (/), listing all server
certificates.
Constraints:
-
Length
1 - 512
-
Pattern
\u002F[\u0021-\u007F]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are
additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true.
Constraints:
-
Range
1 - 1000
Returns information about the ListAccountAliasesResult response and response metadata.
Gets and sets the ListAccountAliasesResult property.
Contains the result of a successful invocation of the ListAccountAliases action.
Contains the result of a successful invocation of the
GetGroupPolicy action.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the PolicyDocument property
The value to set for the PolicyDocument property
this instance
The group the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The name of the policy.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The policy document.
Constraints:
-
Length
1 - 131072
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Contains the result of a successful invocation of the
CreateGroup action.
Sets the Group property
The value to set for the Group property
this instance
Information about the group.
Contains the result of a successful invocation of the
CreateAccessKey action.
Sets the AccessKey property
The value to set for the AccessKey property
this instance
Information about the access key.
StepDetail Unmarshaller
Add Instance Groups Request Marshaller
Class that makes it easy to define Hadoop Streaming steps.
See also: Hadoop Streaming
AWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);
AmazonElasticMapReduce emr = new AmazonElasticMapReduceClient(credentials);
HadoopJarStepConfig config = new StreamingStep()
.WithInputs("s3://elasticmapreduce/samples/wordcount/input")
.WithOutput("s3://my-bucket/output/")
.WithMapper("s3://elasticmapreduce/samples/wordcount/wordSplitter.py")
.WithReducer("aggregate")
.ToHadoopJarStepConfig();
StepConfig wordCount = new StepConfig()
.WithName("Word Count")
.WithActionOnFailure("TERMINATE_JOB_FLOW")
.WithHadoopJarStep(config);
RunJobFlowRequest request = new RunJobFlowRequest()
.WithName("Word Count")
.WithSteps(wordCount)
.WithLogUri("s3://log-bucket/")
.WithInstances(new JobFlowInstancesConfig()
.WithEc2KeyName("keypairt")
.WithHadoopVersion("0.20")
.WithInstanceCount(5)
.WithKeepJobFlowAliveWhenNoSteps(true)
.WithMasterInstanceType("m1.small")
.WithSlaveInstanceType("m1.small"));
RunJobFlowResult result = emr.RunJobFlow(request).RunJobFlowResult;
Creates a new default StreamingStep.
Add more input paths to this step.
inputs a list of inputs to this step.
A reference to this updated object so that method calls can be chained
together.
Set the output path for this step.
The output path.
A reference to this updated object so that method calls can be chained
together.
Set the mapper.
The mapper.
A reference to this updated object so that method calls can be chained
together.
Set the reducer.
The reducer.
A reference to this updated object so that method calls can be chained
together.
Add a Hadoop config override (-D value)
Hadoop configuration key.
Configuration value.
A reference to this updated object so that method calls can be chained
together.
Creates the final HadoopJarStepConfig once you are done configuring the step. You can use
this as you would any other HadoopJarStepConfig.
HadoopJarStepConfig representing this streaming step.
Gets and sets list of step input paths.
The inputs.
Gets and sets the output path.
Gets and sets the mapper.
Gets and sets the reducer.
Gets and sets the hadoopConfig.
Returns information about the RunJobFlowResult response and response metadata.
Gets and sets the RunJobFlowResult property.
The result of the RunJobFlow operation.
Specify the type of Amazon EC2 instances to run the job flow
on.
Sets the MasterInstanceType property
The value to set for the MasterInstanceType property
this instance
Sets the MasterPublicDnsName property
The value to set for the MasterPublicDnsName property
this instance
Sets the MasterInstanceId property
The value to set for the MasterInstanceId property
this instance
Sets the SlaveInstanceType property
The value to set for the SlaveInstanceType property
this instance
Sets the InstanceCount property
The value to set for the InstanceCount property
this instance
Adds elements to the InstanceGroups collection
The values to add to the InstanceGroups collection
this instance
Sets the NormalizedInstanceHours property
The value to set for the NormalizedInstanceHours property
this instance
Sets the Ec2KeyName property
The value to set for the Ec2KeyName property
this instance
Sets the Placement property
The value to set for the Placement property
this instance
Sets the KeepJobFlowAliveWhenNoSteps property
The value to set for the KeepJobFlowAliveWhenNoSteps property
this instance
Sets the HadoopVersion property
The value to set for the HadoopVersion property
this instance
The Amazon EC2 master node instance type.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The DNS name of the master node.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon EC2 instance identifier of the master node.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon EC2 slave node instance type.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The number of Amazon EC2 instances in the cluster. If the value is 1,
the same instance serves as both the master and slave node. If the
value is greater than 1, one instance is the master node and all
others are slave nodes.
Details about the job flow's instance groups.
An approximation of the cost of the job flow, represented in
m1.small/hours. This value is incremented once for every hour an
m1.small runs. Larger instances are weighted more, so an Amazon EC2
instance that is roughly four times more expensive would result in the
normalized instance hours being incremented by four. This result is
only an approximation and does not reflect the actual billing rate.
The name of an Amazon EC2 key pair that can be used to ssh to the
master node of job flow.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the Amazon EC2 Availability Zone for the job flow.
Specifies whether or not the job flow should terminate after
completing all steps.
Specifies the Hadoop version for the job flow.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the DescribeJobFlows operation.
DescribeJobFlows returns a list of job flows that match all of
the supplied parameters. The parameters can include a list of job flow
IDs, job flow states, and restrictions on job flow creation date and
time. Regardless of supplied parameters, only job flows
created within the last two months are returned. If no
parameters are supplied, then job flows matching either of the
following criteria are returned:
- Job flows created and completed in the last two weeks
- Job flows created within the last two months that are in one of
the following states: RUNNING ,
WAITING ,
SHUTTING_DOWN ,
STARTING
Amazon Elastic MapReduce can return a maximum of 512 job flow
descriptions.
Sets the CreatedAfter property
The value to set for the CreatedAfter property
this instance
Sets the CreatedBefore property
The value to set for the CreatedBefore property
this instance
Adds elements to the JobFlowIds collection
The values to add to the JobFlowIds collection
this instance
Adds elements to the JobFlowStates collection
The values to add to the JobFlowStates collection
this instance
Return only job flows created after this date and time.
Return only job flows created before this date and time.
Return only job flows whose job flow ID is contained in this list.
Return only job flows whose state is contained in this list.
Listener Unmarshaller
DeleteLoadBalancerListenersResult Unmarshaller
AmazonElasticLoadBalancing exception
Constructs a new TooManyLoadBalancersException with the specified error
message.
Describes the error encountered.
The InstanceState data type.
Default constructor for a new InstanceState object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Sets the State property
The value to set for the State property
this instance
Sets the ReasonCode property
The value to set for the ReasonCode property
this instance
Sets the Description property
The value to set for the Description property
this instance
Provides an EC2 instance ID.
Specifies the current status of the instance.
Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load
Balancing or the instance behind the Load Balancer.
Provides a description of the instance.
The output for the DescribeLoadBalancers action.
Adds elements to the LoadBalancerDescriptions collection
The values to add to the LoadBalancerDescriptions collection
this instance
Adds elements to the LoadBalancerDescriptions collection
The values to add to the LoadBalancerDescriptions collection
this instance
A list of LoadBalancer description structures.
Container for the parameters to the CreateLoadBalancer operation.
Creates a new LoadBalancer. Once the call has completed successfully, a new LoadBalancer is created; however, it will
not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or
not it is usable by using the DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService
.
NOTE: Currently, the client's quota of LoadBalancers is limited to five per Region. NOTE:
Load balancer DNS names vary depending on the Region they're created in. For load balancers created in the United States, the DNS name ends
with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For load
balancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com
Default constructor for a new CreateLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new CreateLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers.
Constructs a new CreateLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers.
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
A list of Availability Zones. At least one Availability Zone must be specified. Specified Availability
Zones must be in the same EC2 Region as the LoadBalancer. Traffic will be equally distributed across all zones. This list can be modified
after the creation of the LoadBalancer.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
The name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers.
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
A list of Availability Zones. At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region
as the LoadBalancer. Traffic will be equally distributed across all zones. This list can be modified after the creation of the LoadBalancer.
The output for the CreateAppCookieStickinessPolicy action.
The output for the ConfigureHealthCheck action.
Sets the HealthCheck property
The value to set for the HealthCheck property
this instance
The updated healthcheck for the instances.
Response Unmarshaller for UpdateEnvironment operation
Response Unmarshaller for UpdateConfigurationTemplate operation
Update Application Request Marshaller
Response Unmarshaller for TerminateEnvironment operation
Retrieve Environment Info Request Marshaller
EnvironmentInfoDescription Unmarshaller
DescribeConfigurationOptionsResult Unmarshaller
Delete Application Request Marshaller
Response Unmarshaller for CreateStorageLocation operation
Returns information about the RetrieveEnvironmentInfoResult response and response metadata.
Gets and sets the RetrieveEnvironmentInfoResult property.
Result message containing a description of the requested environment info.
Returns information about the RestartAppServer response metadata.
The RestartAppServer operation has a void result type.
Describes the properties of a Listener for the LoadBalancer.
Sets the Protocol property
The value to set for the Protocol property
this instance
Sets the Port property
The value to set for the Port property
this instance
The protocol that is used by the Listener.
The port that is used by the Listener.
Results of a CreateStorageLocationResult call.
Sets the S3Bucket property
The value to set for the S3Bucket property
this instance
The name of the Amazon S3 bucket created.
Constraints:
-
Length
0 - 255
Describes the properties of an environment.
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EndpointURL property
The value to set for the EndpointURL property
this instance
Sets the CNAME property
The value to set for the CNAME property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the Health property
The value to set for the Health property
this instance
Sets the Resources property
The value to set for the Resources property
this instance
The name of this environment.
Constraints:
-
Length
4 - 23
The ID of this environment.
The name of the application associated with this environment.
Constraints:
-
Length
1 - 100
The application version deployed in this environment.
Constraints:
-
Length
1 - 100
The name of the SolutionStack deployed with this environment.
Constraints:
-
Length
0 - 100
The name of the configuration template used to originally launch this environment.
Constraints:
-
Length
1 - 100
Describes this environment.
Constraints:
-
Length
0 - 200
The URL to the LoadBalancer for this environment.
The URL to the CNAME for this environment.
Constraints:
-
Length
1 - 255
The creation date for this environment.
The last modified date for this environment.
The current operational status of the environment: - Launching: Environment is in the process of initial deployment.
- Updating: Environment is in the process of updating its configuration settings or application version.
- Ready:
Environment is available to have an action performed on it, such as update or terminate.
- Terminating: Environment is in
the shut-down process.
- Terminated: Environment is not running.
Constraints:
-
Allowed Values
Launching, Updating, Ready, Terminating, Terminated
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working. Yellow: Indicates that
something is wrong, the application might not be available, but the instances appear running. Green:
Indicates the environment is healthy and fully functional. - Red: Indicates the environment is not
responsive. Occurs when three or more consecutive failures occur for an environment.
- Yellow: Indicates that something is
wrong. Occurs when two consecutive failures occur for an environment.
- Green: Indicates the environment is healthy and
fully functional.
- Grey: Default health for a new environment. The environment is not fully launched and health checks have
not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default:
Grey
Constraints:
-
Allowed Values
Green, Yellow, Red, Grey
The description of the AWS resources used by this environment.
Describes the settings for a configuration set.
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the DeploymentStatus property
The value to set for the DeploymentStatus property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
The name of the solution stack this configuration set uses.
Constraints:
-
Length
0 - 100
The name of the application associated with this configuration set.
Constraints:
-
Length
1 - 100
If not null, the name of the configuration template for this configuration set.
Constraints:
-
Length
1 - 100
Describes this configuration set.
Constraints:
-
Length
0 - 200
If not null, the name of the environment for this configuration set.
Constraints:
-
Length
4 - 23
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this
configuration set: null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the
process of deploying. deployed: This is the configuration that is currently deployed to the
associated running environment. failed: This is a draft configuration, that failed to successfully
deploy. - null: This configuration is not associated with a running environment.
-
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
- deployed: This is the configuration that is currently deployed to the associated running environment.
- failed:
This is a draft configuration that failed to successfully deploy.
Constraints:
-
Allowed Values
deployed, pending, failed
The date (in UTC time) when this configuration set was created.
The date (in UTC time) when this configuration set was last modified.
A list of the configuration options and their values in this configuration set.
Result message containing a single description of an application.
Sets the Application property
The value to set for the Application property
this instance
The ApplicationDescription of the application.
A specification identifying an individual configuration option along with its current value.
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the OptionName property
The value to set for the OptionName property
this instance
Sets the Value property
The value to set for the Value property
this instance
A unique namespace identifying the option's associated AWS resource.
Constraints:
-
Length
1 - 255
The name of the configuration option.
Constraints:
-
Length
1 - 100
The current value for the configuration option.
Constraints:
-
Length
0 - 200
Describes the possible values for a configuration option.
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the Name property
The value to set for the Name property
this instance
Sets the DefaultValue property
The value to set for the DefaultValue property
this instance
Sets the ChangeSeverity property
The value to set for the ChangeSeverity property
this instance
Sets the UserDefined property
The value to set for the UserDefined property
this instance
Sets the ValueType property
The value to set for the ValueType property
this instance
Adds elements to the ValueOptions collection
The values to add to the ValueOptions collection
this instance
Adds elements to the ValueOptions collection
The values to add to the ValueOptions collection
this instance
Sets the MinValue property
The value to set for the MinValue property
this instance
Sets the MaxValue property
The value to set for the MaxValue property
this instance
Sets the MaxLength property
The value to set for the MaxLength property
this instance
Sets the Regex property
The value to set for the Regex property
this instance
A unique namespace identifying the option's associated AWS resource.
Constraints:
-
Length
1 - 255
The name of the configuration option.
Constraints:
-
Length
1 - 100
The default value for this configuration option.
An indication of which action is required if the value for this configuration option changes:
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during
the process. RestartApplicationServer - The environment is available the entire time.
However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
- NoInterruption : There is no interruption to the environment or application availability.
-
RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is
unavailable during the process.
- RestartApplicationServer : The environment is available the entire time. However, a short
application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
An indication of whether the user defined this configuration option: true : This configuration
option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings.
false : This configuration was not defined by the user. - true :
This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating
configuration settings.
- false : This configuration was not defined by the user.
Constraint: You can remove
only UserDefined options from a configuration. Valid Values: true | false
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar : Values for this option are a single selection from the possible values, or a unformatted
string or numeric value governed by the MIN/MAX/Regex constraints: List : Values for this option are
multiple selections of the possible values. Boolean : Values for this option are either true
or false . - Scalar : Values for this option are a single selection from the possible values,
or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
- List : Values for this option
are multiple selections from the possible values.
- Boolean : Values for this option are either true or false
.
Constraints:
-
Allowed Values
Scalar, List
If specified, values for the configuration option are selected from this list.
If specified, the configuration option must be a numeric value greater than this value.
If specified, the configuration option must be a numeric value less than this value.
If specified, the configuration option must be a string value no longer than this value.
If specified, the configuration option must be a string value that satisfies this regular expression.
Container for the parameters to the CheckDNSAvailability operation.
Checks if the specified CNAME is available.
Sets the CNAMEPrefix property
The value to set for the CNAMEPrefix property
this instance
The prefix used when this CNAME is reserved.
Constraints:
-
Length
4 - 63
Fault details for the Spot Instance request, if
any.
Sets the Code property
The reason code for the Spot Instance request
fault
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
The message for the Spot Instance request
fault.
this instance
Checks if Message property is set
true if Message property is set
Gets and sets the Code property.
The reason code for the Spot Instance request
fault
Gets and sets the Message property.
The message for the Spot Instance request
fault.
Sets the DestinationCidrBlock property
The CIDR address block used for the destination match. For example:
0.0.0.0/0.
this instance
Checks if DestinationCidrBlock property is set
true if DestinationCidrBlock property is set
Sets the GatewayId property
The ID of a gateway attached to your VPC.
this instance
Checks if GatewayId property is set
true if GatewayId property is set
Sets the InstanceId property
The ID of a NAT instance in your VPC.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the State property
The state of the route.The blackhole state indicates that the route's
target isn't available (e.g., the specified gateway isn't attached to the
VPC, the specified NAT instance has been terminated, etc.).
this instance
Checks if State property is set
true if State property is set
Gets and sets the DestinationCidrBlock property.
The CIDR address block used for the destination match. For example:
0.0.0.0/0.
Gets and sets the GatewayId property.
The ID of a gateway attached to your VPC.
Gets and sets the InstanceId property.
The ID of a NAT instance in your VPC.
Gets and sets the State property.
The state of the route.The blackhole state indicates that the route's
target isn't available (e.g., the specified gateway isn't attached to the
VPC, the specified NAT instance has been terminated, etc.).
Replaces an entry (i.e., rule) in a network ACL. For more information about network ACLs, go to Network
ACLs in the Amazon Virtual Private Cloud User Guide.
Sets the NetworkAclId property
ID of the ACL where the entry will be replaced.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the RuleNumber property
Rule number of the entry to replace.
this instance
Checks if RuleNumber property is set
true if RuleNumber property is set
Sets the Protocol property
IP protocol the rule applies to.
Valid Values: tcp | udp | icmp or an IP protocol number.
this instance
Checks if Protocol property is set
true if Protocol property is set
Sets the RuleAction property
Whether to allow or deny traffic that matches the rule.
Valid Values: allow | deny
this instance
Checks if RuleAction property is set
true if RuleAction property is set
Sets the Egress property
Whether this rule applies to egress traffic from the No
subnet (true) or ingress traffic (false).
this instance
Checks if Egress property is set
true if Egress property is set
Sets the CidrBlock property
The CIDR range to allow or deny, in CIDR notation
(e.g., 172.16.0.0/24).
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the Icmp property
For the ICMP protocol, this is the ICMP type and code.
this instance
Checks if Icmp property is set
true if Icmp property is set
Sets the PortRange property
For the TCP or UDP protocols, the range of ports the rule applies to.
this instance
Checks if PortRange property is set
true if PortRange property is set
Gets and sets the NetworkAclId property.
ID of the ACL where the entry will be replaced.
Gets and sets the RuleNumber property.
Rule number of the entry to replace.
Gets and sets the Protocol property.
IP protocol the rule applies to.
Valid Values: tcp | udp | icmp or an IP protocol number.
Gets and sets the RuleAction property.
Whether to allow or deny traffic that matches the rule.
Valid Values: allow | deny
Gets and sets the Egress property.
Whether this rule applies to egress traffic from the No
subnet (true) or ingress traffic (false).
Gets and sets the CidrBlock property.
The CIDR range to allow or deny, in CIDR notation
(e.g., 172.16.0.0/24).
Gets and sets the Icmp property.
For the ICMP protocol, this is the ICMP type and code.
Gets and sets the PortRange property.
For the TCP or UDP protocols, the range of ports the rule applies to.
Specifies the placement constraints.
Sets the AvailabilityZone property
Availability Zones for launching the instances.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the GroupName property
The name of a PlacementGroup.
this instance
Checks if GroupName property is set
true if GroupName property is set
Checks if Tenancy property is set
true if Tenancy property is set
Sets the Tenancy property
Valid Values: default | dedicated
The tenancy of the instance.
this instance
Gets and sets the AvailabilityZone property.
Availability Zones for launching the instances.
Gets and sets the GroupName property.
The name of a PlacementGroup.
Gets and sets the Tenancy property.
The tenancy of the instance.
Valid Values: default | dedicated
A list of instance attributes.
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the InstanceType property
The instance type (e.g., m1.small, c1.medium,
m2.2xlarge, and so
on).
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the KernelId property
The kernel ID.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
The RAM disk ID.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the UserData property
MIME, Base64-encoded user data.
this instance
Checks if UserData property is set
true if UserData property is set
Sets the DisableApiTermination property
Specifies whether the instance can be
terminated. You must
modify this attribute before you can
terminate any "locked" instances.
this instance
Checks if DisableApiTermination property is set
true if DisableApiTermination property is set
Sets the InstanceInitiatedShutdownBehavior property
Specifies whether the instance's Amazon EBS
volumes are deleted when the instance is shut down.
Type:
NullableAttributeBooleanValueType
this instance
Checks if InstanceInitiatedShutdownBehavior property is set
true if InstanceInitiatedShutdownBehavior property is set
Sets the RootDeviceName property
The root device name (e.g., /dev/sda1).
this instance
Checks if RootDeviceName property is set
true if RootDeviceName property is set
Sets the BlockDeviceMapping property
Block device mapping set.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the InstanceType property.
The instance type (e.g., m1.small, c1.medium,
m2.2xlarge, and so
on).
Gets and sets the KernelId property.
The kernel ID.
Gets and sets the RamdiskId property.
The RAM disk ID.
Gets and sets the UserData property.
MIME, Base64-encoded user data.
Gets and sets the DisableApiTermination property.
Specifies whether the instance can be
terminated. You must
modify this attribute before you can
terminate any "locked" instances.
Gets and sets the InstanceInitiatedShutdownBehavior property.
Specifies whether the instance's Amazon EBS
volumes are deleted when the instance is shut down.
Type:
NullableAttributeBooleanValueType
Gets and sets the RootDeviceName property.
The root device name (e.g., /dev/sda1).
Gets and sets the BlockDeviceMapping property.
Block device mapping set.
Specifies additional launch instance information.
Sets the Architecture property
Architecture of the instance.
Valid Values: i386 | x86_64
this instance
Checks if Architecture property is set
true if Architecture property is set
Sets the SecurityGroup property
One or more security group names.
this instance
Checks if SecurityGroup property is set
true if SecurityGroup property is set
Sets the UserData property
User data to be made available to the instance.
this instance
Checks if UserData property is set
true if UserData property is set
Sets the InstanceType property
Specifies the instance type.
Valid Values:
m1.small | m1.large | m1.xlarge | c1.medium |
c1.xlarge |
m2.2xlarge | m2.4xlarge
Default: m1.small
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the Placement property
Specifies the placement constraints.
this instance
Checks if Placement property is set
true if Placement property is set
Sets the Monitoring property
Enables monitoring for the instance.
this instance
Checks if Monitoring property is set
true if Monitoring property is set
Sets the SubnetId property
If you're using Amazon Virtual Private Cloud, this specifies the ID of the subnet you want to launch the instance into.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the InstanceInitiatedShutdownBehavior property
Determines whether the instance stops or terminates on instance-initiated shutdown.
Valid Values: stop | terminate
this instance
Checks if InstanceInitiatedShutdownBehavior property is set
true if InstanceInitiatedShutdownBehavior property is set
Sets the PrivateIpAddress property
If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet (e.g., 10.0.0.25).
this instance
Checks if PrivateIpAddress property is set
true if PrivateIpAddress property is set
Gets and sets the Architecture property.
Architecture of the instance.
Valid Values: i386 | x86_64
Gets and sets the SecurityGroup property.
One or more security group names.
Gets and sets the UserData property.
User data to be made available to the instance.
Gets and sets the InstanceType property.
Specifies the instance type.
Valid Values:
m1.small | m1.large | m1.xlarge | c1.medium |
c1.xlarge |
m2.2xlarge | m2.4xlarge
Default: m1.small
Gets and sets the Placement property.
Specifies the placement constraints.
Gets and sets the Monitoring property.
Enables monitoring for the instance.
Gets and sets the SubnetId property.
If you're using Amazon Virtual Private Cloud, this specifies the ID of the subnet you want to launch the instance into.
Gets and sets the InstanceInitiatedShutdownBehavior property.
Determines whether the instance stops or terminates on instance-initiated shutdown.
Valid Values: stop | terminate
Gets and sets the PrivateIpAddress property.
If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet (e.g., 10.0.0.25).
The Result containing the Spot Price history data.
Checks if SpotPriceHistory property is set
true if SpotPriceHistory property is set
Checks if NextToken property is set
true if NextToken property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SpotPriceHistory property.
List of data points specifying the Spot Price history.
Gets and sets the NextToken property.
The string marking the next set of results returned. Displays empty
if there are no more results to be returned.
Describe Snapshots Response
Checks if DescribeSnapshotsResult property is set
true if DescribeSnapshotsResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the DescribeSnapshotsResult property.
Describe Snapshots Result
Gets and sets the ResponseMetadata property.
Response Metadata
Gives you information about your route tables.You can filter the results to return information only about
tables that match criteria you specify. For example, you could get information only about a table associated
with a particular subnet.You can specify multiple values for the filter. The table must match at least one
of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular
subnet). The result includes information for a particular table only if it matches all your filters. If there's
no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Sets the RouteTableId property
IDs of the route tables.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the Filter property
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the RouteTableId property.
IDs of the route tables.
Gets and sets the Filter property.
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Regions Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeRegionsResult property is set
true if DescribeRegionsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeRegionsResult property.
Describe Regions Result
Describes regions that are currently available to
the account.
Sets the RegionName property
Name of a region.
this instance
Checks if RegionName property is set
true if RegionName property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Region.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the RegionName property.
Name of a region.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Region.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
The Response for the
DescribeInternetGateways operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeInternetGatewaysResult property is set
true if DescribeInternetGatewaysResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeInternetGatewaysResult property.
DescribeInternetGateways Result
Returns information about AMIs, AKIs, and ARIs.
This includes image type, product
codes, architecture, and kernel
and RAM disk IDs. Images available to
you include public images,
private images that you own, and private images owned by other
users for which you have explicit launch permissions.
Launch
permissions fall into three categories:
1. public:
The owner of the AMI granted launch permissions for the AMI to the
all group. All users have launch permissions for these AMIs.
explicit:
The owner of the AMI granted launch permissions to a specific user.
3. implicit:
A user has implicit launch permissions for all AMIs he or she
owns.
The list of AMIs returned can be modified by specifying AMI IDs,
AMI owners, or users with launch permissions. If no options are
specified, Amazon EC2 returns all AMIs for
which the user has launch permissions.
If you specify one or more AMI IDs, only AMIs that have the
specified IDs are returned. If you specify an invalid AMI
ID, a fault is returned. If you specify an AMI ID for which
you do not have access, it will not be included in the returned
results.
If you specify one or more AMI owners, only AMIs from the
specified owners and for which you have access are returned. The
results can include the account IDs of the
specified owners, amazon for AMIs owned by Amazon or self for AMIs that you
own.
If you specify a list of executable users, only users that have
launch permissions for the AMIs are returned. You can specify account IDs
(if you own the AMI(s)), self for AMIs for which you own or have
explicit permissions, or all for public AMIs.
Sets the ImageId property
AMI IDs to describe.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the Owner property
Returns AMIs owned by the specified owner.
Multiple owners can be specified.
this instance
Checks if Owner property is set
true if Owner property is set
Sets the ExecutableBy property
Returns AMIs for which the specified user has
explicit launch permissions.
this instance
Checks if ExecutableBy property is set
true if ExecutableBy property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Images.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the ImageId property.
AMI IDs to describe.
Gets and sets the Owner property.
Returns AMIs owned by the specified owner.
Multiple owners can be specified.
Gets and sets the ExecutableBy property.
Returns AMIs for which the specified user has
explicit launch permissions.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified Images.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
DescribeConversionTasks Result
Checks if ConversionTasks property is set
true if ConversionTasks property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ConversionTasks property.
A list of conversion tasks.
Delete Vpn Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Deletes a snapshot of an Amazon EBS volume that
you own.
For more information, go to the Amazon Elastic Compute Cloud
Developer Guide
Sets the SnapshotId property
The ID of the Amazon EBS snapshot to delete.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Gets and sets the SnapshotId property.
The ID of the Amazon EBS snapshot to delete.
Deletes a network ACL from a VPC. The ACL must not have any subnets associated with it.You can't
delete the default network ACL. For more information about network ACLs, go to Network ACLs in the
Amazon Virtual Private Cloud User Guide.
Sets the NetworkAclId property
The ID of the network ACL to be deleted.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Gets and sets the NetworkAclId property.
The ID of the network ACL to be deleted.
Customer Gateway
Sets the CustomerGatewayId property
The ID of the customer gateway
this instance
Checks if CustomerGatewayId property is set
true if CustomerGatewayId property is set
Sets the CustomerGatewayState property
The current state of the customer gateway
(pending, available, deleting, deleted)
this instance
Checks if CustomerGatewayState property is set
true if CustomerGatewayState property is set
Sets the Type property
The type of VPN connection the customer gateway
supports (ipsec.1).
this instance
Checks if Type property is set
true if Type property is set
Sets the IpAddress property
The Internet-routable IP address of the
customer gateway's outside
interface
this instance
Checks if IpAddress property is set
true if IpAddress property is set
Sets the BgpAsn property
The customer gateway's Border Gateway Protocol
(BGP) Autonomous System Number (ASN).
this instance
Checks if BgpAsn property is set
true if BgpAsn property is set
Sets the Tag property
A list of tags for the CustomerGateway.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the CustomerGatewayId property.
The ID of the customer gateway
Gets and sets the CustomerGatewayState property.
The current state of the customer gateway
(pending, available, deleting, deleted)
Gets and sets the Type property.
The type of VPN connection the customer gateway
supports (ipsec.1).
Gets and sets the IpAddress property.
The Internet-routable IP address of the
customer gateway's outside
interface
Gets and sets the BgpAsn property.
The customer gateway's Border Gateway Protocol
(BGP) Autonomous System Number (ASN).
Gets and sets the Tag property.
A list of tags for the CustomerGateway.
Create Vpn Gateway Result
Checks if VpnGateway property is set
true if VpnGateway property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the VpnGateway property.
Vpn gateway
Creates a new Amazon EBS volume to which any
Amazon EC2 instance can attach
within the same Availability Zone.
For more information about Amazon
EBS, go to the Amazon Elastic
Compute Cloud Developer Guide.
You must specify an Availability
Zone when creating a volume. The
volume and the instance to which it
attaches must be in the same Availability Zone.
Sets the Size property
The size of the volume, in GiBs. Required if
you are not creating
a volume from a snapshot.
Valid Values: 1-1024
this instance
Checks if Size property is set
true if Size property is set
Sets the SnapshotId property
The snapshot from which to create the new
volume.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the AvailabilityZone property
The Availability Zone in which to create the
new volume.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Gets and sets the Size property.
The size of the volume, in GiBs. Required if
you are not creating
a volume from a snapshot.
Valid Values: 1-1024
Gets and sets the SnapshotId property.
The snapshot from which to create the new
volume.
Gets and sets the AvailabilityZone property.
The Availability Zone in which to create the
new volume.
Creates a snapshot of an Amazon EBS volume and
stores it in Amazon S3. You can
use snapshots for backups, to make
identical copies of instance
devices, and to save data before
shutting down an instance. For more information about
Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide.
When taking a snapshot of a file system, we recommend unmounting it
first. This ensures the file system metadata is in a consistent state,
that the 'mounted indicator' is cleared, and that all applications
using that file system are stopped and in a consistent state. Some file
systems, such as xfs, can freeze and unfreeze activity so a
snapshot can be made without unmounting.
For Linux/UNIX, enter the
following command from the command line.
umount -d /dev/sdh
For Windows, open Disk Management, right-click the volume to unmount,
and select Change Drive Letter and Path. Then, select the mount
point to remove
and click Remove.
Sets the VolumeId property
The ID of the Amazon EBS volume of which to
take a snapshot.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the Description property
Description of the Amazon EBS snapshot.
this instance
Checks if Description property is set
true if Description property is set
Gets and sets the VolumeId property.
The ID of the Amazon EBS volume of which to
take a snapshot.
Gets and sets the Description property.
Description of the Amazon EBS snapshot.
The Response for the
CreateNetworkAcl operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateNetworkAclResult property is set
true if CreateNetworkAclResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateNetworkAclResult property.
CreateNetworkAcl Result
The Response for the
CreateNetworkAclEntry operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Attach Volume Response
Checks if AttachVolumeResult property is set
true if AttachVolumeResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the AttachVolumeResult property.
Attach Volume Result
Gets and sets the ResponseMetadata property.
Response Metadata
Get Metric Statistics Request Marshaller
The ListStreamingDistributionsRequest contains the parameters used for the ListStreamingDistributions operation.
All parameters to this request object are optional.
Sets the Marker property for this request.
All keys returned will be lexiographically after the marker.
the value that Marker is set to
this instance
Sets the MaxItems property for this request.
Limits the result set of keys to MaxItems.
the value that MaxItems is set to
this instance
Gets and sets the Marker property.
All keys returned will be lexiographically after the marker.
Gets and sets the MaxItems property.
Limits the result set of keys to MaxItems.
Response Unmarshaller for ListStacks operation
The TemplateParameter data type.
Sets the ParameterKey property
The value to set for the ParameterKey property
this instance
Sets the DefaultValue property
The value to set for the DefaultValue property
this instance
Sets the NoEcho property
The value to set for the NoEcho property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name associated with the parameter.
The default value associated with the parameter.
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
User defined description associated with the parameter.
Returns information about the GetTemplateResult response and response metadata.
Gets and sets the GetTemplateResult property.
The output for GetTemplate action.
Implemenation for accessing AmazonCloudFormation.
AWS CloudFormation This is the AWS CloudFormation API Reference. The major sections of this guide are described in the following
table.
- Actions: Alphabetical list of CloudFormation actions
- Data Types: Alphabetical list of CloudFormation data types
- Common Parameters: Parameters that all Query actions can use
- Common Errors: Client and server errors that all actions can return
This guide is for programmers who need detailed information about the CloudFormation APIs. You use AWS CloudFormation to create and
manage AWS infrastructure deployments predictably and repeatedly. 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 the AWS infrastructure. Through the use of a template file you write, and a few AWS CloudFormation
commands or API actions, AWS CloudFormation enables you to manage a collection of resources together 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. For more information about this product, go to the CloudFormation Product Page. 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 http://aws.amazon.com/documentation/.
Interface for accessing AmazonCloudFormation.
AWS CloudFormation This is the AWS CloudFormation API Reference. The major sections of this guide are described in the following
table.
- Actions: Alphabetical list of CloudFormation actions
- Data Types: Alphabetical list of CloudFormation data types
- Common Parameters: Parameters that all Query actions can use
- Common Errors: Client and server errors that all actions can return
This guide is for programmers who need detailed information about the CloudFormation APIs. You use AWS CloudFormation to create and
manage AWS infrastructure deployments predictably and repeatedly. 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 the AWS infrastructure. Through the use of a template file you write, and a few AWS CloudFormation
commands or API actions, AWS CloudFormation enables you to manage a collection of resources together 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. For more information about this product, go to the CloudFormation Product Page. 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 http://aws.amazon.com/documentation/.
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).
Container for the necessary parameters to execute the ListStacks service method on
AmazonCloudFormation.
The response from the ListStacks service method, as returned by AmazonCloudFormation.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the
status of the stack via the DescribeStacks API. NOTE: Currently, the limit for stacks is 20 stacks per account per
region.
Container for the necessary parameters to execute the CreateStack service method on
AmazonCloudFormation.
The response from the CreateStack service method, as returned by AmazonCloudFormation.
Validates a specified template.
Container for the necessary parameters to execute the ValidateTemplate service method on
AmazonCloudFormation.
The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks
created.
Container for the necessary parameters to execute the DescribeStacks service method on
AmazonCloudFormation.
The response from the DescribeStacks service method, as returned by AmazonCloudFormation.
Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks
with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack's
event history, go to the AWS CloudFormation User Guide. NOTE:Events are returned, even if the stack never existed or
has been successfully deleted.
Container for the necessary parameters to execute the DescribeStackEvents service method on
AmazonCloudFormation.
The response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.
Returns the template body for a specified stack name. You can get the template for running or deleted stacks. For deleted
stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. NOTE: If the template does
not exist, a ValidationError is returned.
Container for the necessary parameters to execute the GetTemplate service method on
AmazonCloudFormation.
The response from the GetTemplate service method, as returned by AmazonCloudFormation.
Returns the description for the specified resource in the specified stack. For deleted stacks, DescribeStackResource
returns resource information for up to 90 days after the stack has been deleted. You must specify StackName and
LogicalResourceId .
Container for the necessary parameters to execute the DescribeStackResource service method on
AmazonCloudFormation.
The response from the DescribeStackResource service method, as returned by AmazonCloudFormation.
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the
DescribeStacks API if the deletion has been completed successfully.
Container for the necessary parameters to execute the DeleteStack service method on
AmazonCloudFormation.
Returns descriptions for all resources of the specified stack. For deleted stacks, ListStackResources returns resource
information for up to 90 days after the stack has been deleted.
Container for the necessary parameters to execute the ListStackResources service method on
AmazonCloudFormation.
The response from the ListStackResources service method, as returned by AmazonCloudFormation.
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that
are part of the stack are returned. If PhysicalResourceId is specified, all the associated resources of the stack the resource
belongs to are returned. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
stack has been deleted. You must specify StackName or PhysicalResourceId. In addition, you can specify
LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and
PhysicalResourceId , go to the AWS CloudFormation User Guide. NOTE: A ValidationError is returned if you specify
both StackName and PhysicalResourceId in the same request.
Container for the necessary parameters to execute the DescribeStackResources service method on
AmazonCloudFormation.
The response from the DescribeStackResources service method, as returned by AmazonCloudFormation.
Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an
AmazonCloudFormationClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonCloudFormationClient Configuration Object
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).
Container for the necessary parameters to execute the ListStacks service method on
AmazonCloudFormation.
The response from the ListStacks service method, as returned by AmazonCloudFormation.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the
status of the stack via the DescribeStacks API. NOTE: Currently, the limit for stacks is 20 stacks per account per
region.
Container for the necessary parameters to execute the CreateStack service method on
AmazonCloudFormation.
The response from the CreateStack service method, as returned by AmazonCloudFormation.
Validates a specified template.
Container for the necessary parameters to execute the ValidateTemplate service method on
AmazonCloudFormation.
The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks
created.
Container for the necessary parameters to execute the DescribeStacks service method on
AmazonCloudFormation.
The response from the DescribeStacks service method, as returned by AmazonCloudFormation.
Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks
with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack's
event history, go to the AWS CloudFormation User Guide. NOTE:Events are returned, even if the stack never existed or
has been successfully deleted.
Container for the necessary parameters to execute the DescribeStackEvents service method on
AmazonCloudFormation.
The response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.
Returns the template body for a specified stack name. You can get the template for running or deleted stacks. For deleted
stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. NOTE: If the template does
not exist, a ValidationError is returned.
Container for the necessary parameters to execute the GetTemplate service method on
AmazonCloudFormation.
The response from the GetTemplate service method, as returned by AmazonCloudFormation.
Returns the description for the specified resource in the specified stack. For deleted stacks, DescribeStackResource
returns resource information for up to 90 days after the stack has been deleted. You must specify StackName and
LogicalResourceId .
Container for the necessary parameters to execute the DescribeStackResource service method on
AmazonCloudFormation.
The response from the DescribeStackResource service method, as returned by AmazonCloudFormation.
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the
DescribeStacks API if the deletion has been completed successfully.
Container for the necessary parameters to execute the DeleteStack service method on
AmazonCloudFormation.
Returns descriptions for all resources of the specified stack. For deleted stacks, ListStackResources returns resource
information for up to 90 days after the stack has been deleted.
Container for the necessary parameters to execute the ListStackResources service method on
AmazonCloudFormation.
The response from the ListStackResources service method, as returned by AmazonCloudFormation.
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that
are part of the stack are returned. If PhysicalResourceId is specified, all the associated resources of the stack the resource
belongs to are returned. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
stack has been deleted. You must specify StackName or PhysicalResourceId. In addition, you can specify
LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and
PhysicalResourceId , go to the AWS CloudFormation User Guide. NOTE: A ValidationError is returned if you specify
both StackName and PhysicalResourceId in the same request.
Container for the necessary parameters to execute the DescribeStackResources service method on
AmazonCloudFormation.
The response from the DescribeStackResources service method, as returned by AmazonCloudFormation.
ScheduledUpdateGroupAction Unmarshaller
Disable Metrics Collection Request Marshaller
DescribeScalingActivitiesResult Unmarshaller
Describe Notification Configurations Request Marshaller
Delete Launch Configuration Request Marshaller
Delete Auto Scaling Group Request Marshaller
There are two primary Auto Scaling process types-- Launch and Terminate . The Launch process creates a new
Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existing Amazon EC2 instance. The
remaining Auto Scaling process types relate to specific Auto Scaling features:
- AlarmNotifications
- AZRebalance
- HealthCheck
- ReplaceUnhealthy
- ScheduledActions
IMPORTANT: If you suspend Launch or Terminate, all other process types are affected to varying degrees. The following
descriptions discuss how each process type is affected by a suspension of Launch or Terminate. The AlarmNotifications
process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the
AlarmNotifications process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.
Although the AlarmNotifications process type is not directly affected by a suspension of Launch or
Terminate ,
alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend
Launch or Terminate , Auto Scaling might not be able to implement the alarm's associated policy. The
AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an
Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new
instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone
returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated
Availability Zones. IMPORTANT: If you call SuspendProcesses on the launch process type, the AZRebalance process will
neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only
after launching the replacement instances. If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause
your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily
grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could
remain up to ten percent larger than the maximum size until you resume the terminate process type. The HealthCheck
process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs
Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with
SetInstanceHealth. The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and
subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then
Launch .
IMPORTANT: The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide
health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.
The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled
actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate ,
your scheduled actions might not function as expected.
Sets the ProcessName property
The value to set for the ProcessName property
this instance
The name of a process.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The NotificationConfiguration data type.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the TopicARN property
The value to set for the TopicARN property
this instance
Sets the NotificationType property
The value to set for the NotificationType property
this instance
Specifies the Auto Scaling group name.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The types of events for an action to start.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
AmazonAutoScaling exception
Constructs a new InvalidNextTokenException with the specified error
message.
Describes the error encountered.
Returns information about the ExecutePolicy response metadata.
The ExecutePolicy operation has a void result type.
Container for the parameters to the CreateLaunchConfiguration operation.
Creates a new launch configuration. Once created, the new launch configuration is available for immediate use.
NOTE: The launch configuration name used must be unique, within the scope of the client's AWS account, and the maximum limit of
launch configurations must not yet have been met, or else the call will fail.
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Sets the ImageId property
The value to set for the ImageId property
this instance
Sets the KeyName property
The value to set for the KeyName property
this instance
Adds elements to the SecurityGroups collection
The values to add to the SecurityGroups collection
this instance
Adds elements to the SecurityGroups collection
The values to add to the SecurityGroups collection
this instance
Sets the UserData property
The value to set for the UserData property
this instance
Sets the InstanceType property
The value to set for the InstanceType property
this instance
Sets the KernelId property
The value to set for the KernelId property
this instance
Sets the RamdiskId property
The value to set for the RamdiskId property
this instance
Adds elements to the BlockDeviceMappings collection
The values to add to the BlockDeviceMappings collection
this instance
Adds elements to the BlockDeviceMappings collection
The values to add to the BlockDeviceMappings collection
this instance
Sets the InstanceMonitoring property
The value to set for the InstanceMonitoring property
this instance
The name of the launch configuration to create.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Unique ID of the Amazon Machine Image (AMI) which was assigned during registration. For more information about Amazon EC2 images,
please see Amazon EC2 product documentation
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the EC2 key pair.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The names of the security groups with which to associate EC2 instances. For more information about Amazon EC2 security groups, go to the Amazon EC2 product documentation.
The user data available to the launched EC2 instances. For more information about Amazon EC2 user data, please see Amazon EC2 product documentation.
Constraints:
-
Length
0 - 21847
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The instance type of the EC2 instance. For more information about Amazon EC2 instance types, please see Amazon EC2 product documentation
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The ID of the kernel associated with the EC2 AMI.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The ID of the RAM disk associated with the EC2 AMI.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a VirtualName, a
DeviceName, and an ebs data structure that contains information about the associated Elastic Block Storage volume. For more
information about Amazon EC2 BlockDeviceMappings, please go to Block Device Mapping in
the Amazon EC2 product documentation.
Enables detailed monitoring.
The AutoScalingInstanceDetails data type.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the LifecycleState property
The value to set for the LifecycleState property
this instance
Sets the HealthStatus property
The value to set for the HealthStatus property
this instance
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
The instance's Amazon EC2 instance ID.
Constraints:
-
Length
1 - 16
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the Auto Scaling group associated with this instance.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The availability zone in which this instance resides.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The life cycle state of this instance.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the
instance is unhealthy. Auto Scaling should terminate and replace it.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The launch configuration associated with this instance.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Alarm data type.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the AlarmARN property
The value to set for the AlarmARN property
this instance
The name of the alarm
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of the alarm.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The available AWS access control policy actions for Amazon Simple
Notification Service.
Action for the AddPermission operation on Amazon SNS.
Action for the AddPermission operation on Amazon SNS.
Action for the GetTopicAttributes operation on Amazon SNS.
Action for the ListSubscriptionsByTopic operation on Amazon SNS.
Action for the Publish operation on Amazon SNS.
Action for the RemovePermission operation on Amazon SNS.
Action for the SetTopicAttributes operation on Amazon SNS.
Action for the Subscribe operation on Amazon SNS.
A
A
Information about the message sent to Amazon SQS.
Checks if MessageId property is set
true if MessageId property is set
Checks if MD5OfMessageBody property is set
true if MD5OfMessageBody property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the MessageId property.
An element containing the message ID of the message sent to the queue.
Gets and sets the MD5OfMessageBody property.
An MD5 digest of the non-URL-encoded message body string. You can use this to verify that SQS received the message
correctly. SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to
http://faqs.org/rfcs/rfc1321.html.
Returns a list of messages and metadata about the request.
Checks if ReceiveMessageResult property is set
true if ReceiveMessageResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ReceiveMessageResult property.
A list of messages associated with the ReceiveMessageRequest.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
A list of attributes returned by the GetQueueAttributesRequest.
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
Returns the attributes that match the request.
Checks if GetQueueAttributesResult property is set
true if GetQueueAttributesResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the GetQueueAttributesResult property.
A list of attributes returned by the GetQueueAttributesRequest.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Adds the specified permission(s) to a queue for the specified principal(s). This allows for sharing access to the queue.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the Label property
The unique identification of the permission you're setting. Maximum 80 characters; alphanumeric characters, hyphens (-),
and underscores (_) are allowed.
this instance
Checks if Label property is set
true if Label property is set
Sets the AWSAccountId property
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does
not need to be signed up for Amazon SQS.
this instance
Checks if AWSAccountId property is set
true if AWSAccountId property is set
Sets the ActionName property
The action you want to allow for the specified principal. For more information about these actions, see Understanding
Permissions in the Amazon SQS Developer Guide.
Valid values are: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes
this instance
Checks if ActionName property is set
true if ActionName property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the Label property.
The unique identification of the permission you're setting. Maximum 80 characters; alphanumeric characters, hyphens (-),
and underscores (_) are allowed.
Gets and sets the AWSAccountId property.
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does
not need to be signed up for Amazon SQS.
Gets and sets the ActionName property.
The action you want to allow for the specified principal. For more information about these actions, see Understanding
Permissions in the Amazon SQS Developer Guide.
Valid values are: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes
Encapsulates the metadata and result of the Unsubscribe action.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
A wrapper type for the topic's Amazon Resource Name (ARN).
To retrieve a topic's attributes, use GetTopicAttributes.
Sets the TopicArn property
TopicArn property
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Gets and sets the TopicArn property.
The Metadata used to identify the service request uniquely.
Sets the RequestId property
The Id associated with the request. Be sure to reference
this Id when contacting AWS support.
this instance
Checks if RequestId property is set
true if RequestId property is set
Gets and sets the RequestId property.
The Id associated with the request. Be sure to reference
this Id when contacting AWS support.
A specific error associated with a Amazon SimpleDB request.
Sets the Type property
The error type.
this instance
Checks if Type property is set
true if Type property is set
Sets the Code property
The specific error code.
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
The specific error code.
this instance
Checks if Message property is set
true if Message property is set
Sets the Detail property
Details associated with the error.
this instance
Checks if Detail property is set
true if Detail property is set
Gets and sets the Type property.
The error type.
Gets and sets the Code property.
The specific error code.
Gets and sets the Message property.
The specific error code.
Gets and sets the Detail property.
Details associated with the error.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
The SetACLResponse contains any headers returned by S3.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
The command to manage an upload using the S3 multipart API.
Initializes a new instance of the class.
The s3 client.
The config object that has the number of threads to use.
The file transporter request.
Runs the multipart upload.
Used as the ThreadStart for the threads doing the upload.
The GetObjectRequest contains the parameters used for the GetObject operation.
For more information about the optional parameters,
refer:
Required Parameters: BucketName, Key
Optional Parameters: VersionId, ModifiedSinceDate, UnmodifiedSinceDate,
ETagToMatch, ETagToNotMatch, ByteRange
Sets the BucketName property for this request.
This is the S3 Bucket that contains the S3 Object you
want to get.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you want to Get.
The value that Key is set to
this instance
Checks if Key property is set.
true if Key property is set.
Sets the VersionId property for this request.
This is the VersionId for the S3 Object you want to Get.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Sets the ModifiedSinceDate property for this request.
When this is set the S3 object is returned only if it
has been modified since the specified time, otherwise
returns a 304 (not modified).
The value that ModifiedSinceDate is set to
this instance
Checks if ModifiedSinceDate property is set.
true if ModifiedSinceDate property is set.
Sets the UnmodifiedSinceDate property for this request.
When this is set the S3 object is returned only if it
has not been modified since the specified time, otherwise
return a 412 (precondition failed).
The value that UnmodifiedSinceDate is set to
this instance
Checks if UnmodifiedSinceDate property is set.
true if UnmodifiedSinceDate property is set.
Sets the ETagToMatch property for this request.
When this is set the S3 object is returned only if
its entity tag (ETag) is the same as the one specified,
otherwise return a 412 (precondition failed).
The value that ETagToMatch is set to
this instance
Checks if ETagToMatch property is set.
true if ETagToMatch property is set.
Sets the ETagToNotMatch property for this request.
When this is set the S3 object is returned only if
its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).
The value that ETagToNotMatch is set to
this instance
Checks if ETagToNotMatch property is set.
true if ETagToNotMatch property is set.
Sets the ByteRangeLong property with the start and end index
specified.
When this is set the request downloads the specified range of an object.
Specifies the index to start at
Specifies the index to end at
this instance
Sets the ByteRange property with the start and end index
specified.
When this is set the request downloads the specified range of an object.
Specifies the index to start at
Specifies the index to end at
this instance
Checks if ByteRange property is set.
true if ByteRange property is set.
Sets the Timeout property (in milliseconds).
The value of this property is assigned to the
Timeout property of the HttpWebRequest
Please specify a timeout value only if you are certain that
the file will not be retrieved within the default intervals
specified for an HttpWebRequest.
Timeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
ReadWriteTimeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the ResponseHeaderOverrides property and returns back this instance for method chaining.
The response headers
this instance
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the VersionId property.
Gets and sets the ModifiedSinceDate property.
Gets and sets the UnmodifiedSinceDate property.
Gets and sets the ETagToMatch property.
Gets and sets the ETagToNotMatch property.
Gets and sets the ByteRangeLong property.
Gets the ByteRange property.
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
Timeout property of the
HTTPWebRequest object used for S3 GET Object requests.
A value less than or equal to 0 will be silently ignored
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout properties of the
HTTPWebRequest object used for S3 GET Object requests.
A value less than or equal to 0 will be silently ignored
Gets and sets the response headers to be returned back with the response of the object.
The CopyObjectResponse contains all the information about the
CopyObject operation.
Gets and sets the LastModified property.
Gets and sets the ETag property.
Gets and sets the SourceVersionId property.
This is the Version Id of the Source Object
Gets and sets the VersionId property.
This is the version-id of the object in the destination bucket
Gets and sets the Headers property.
Represents an S3 Bucket.
Contains a Bucket Name which is the name of the S3 Bucket.
And a Creation Date which is the date that the S3 Bucket was created.
Checks if BucketName property is set
true if BucketName property is set
Checks if CreationDate property is set
true if CreationDate property is set
Gets and sets the BucketName property.
Gets and sets the CreationDate property.
The date conforms to the ISO8601 date format.
The GetPreSignedUrlRequest contains the parameters used to create
a pre signed URL. For more information, refer:
Required Parameters: BucketName, Expires
Optional Parameters: Key, VersionId, Verb: default is GET
Sets the BucketName property for this request.
This is the S3 Bucket that contains the S3 Object
you want to create a pre signed URL for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you want to create a
pre signed URL for.
The value that Key is set to
this instance
Checks if Key property is set.
true if Key property is set.
Sets the ContentType property for this request.
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
the value the ContentType to be set to
The request with the ContentType set
Checks if ContentType property is set.
true if ContentType property is set.
Sets the Expires property for this request.
The time when the signature expires, specified as a DateTime
Object.
The value that Expires is set to
this instance
Checks if Expires property is set.
true if Expires property is set.
Sets the Protocol property for this request.
Specifies whether the pre signed URL will use
http or https. Defaults to https unless otherwise
set.
The value that Protocol is set to
the response with the Protocol set
Sets the Verb property for this request.
Specifies which verb to use in the pre-signed URL.
Accepted verbs are GET, PUT and HEAD.
Default value is GET.
The value that Verb is set to
the response with the Verb set
Sets the VersionId property for this request.
This is the VersionId for the S3 Object you want to get
a PreSigned URL for. The VersionId property will be ignored
for PreSigned "PUT" requests and for requests that don't specify
the Key property.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Sets the ResponseHeaderOverrides property and returns back this instance for method chaining.
The response headers
this instance
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the ContentType property.
Gets and sets the Expires property.
Gets and sets the Protocol property.
Gets and sets the Verb property.
Specifies the verb used in the pre-signed URL.
Accepted verbs are GET, PUT and HEAD.
Default is GET.
Gets and sets the VersionId property.
This is the VersionId for the S3 Object you want to get
a PreSigned URL for. The VersionId property will be ignored
for PreSigned "PUT" requests and for requests that don't specify
the Key property.
Gets and sets the response headers to be returned back with the response of the object.
The valid hashing algorithm supported by the sdk for request signing.
Which end of a request was responsible for a service error response.
The sender was responsible for the error, i.e. the client
request failed validation or was improperly formatted.
The error occured within the service.
An unrecognized error type was returned.
Result Unmarshaller for RevokeDBSecurityGroupIngress operation
Reboot D B Instance Request Marshaller
ModifyDBParameterGroupResult Unmarshaller
Response Unmarshaller for ModifyDBParameterGroup operation
Describe Reserved D B Instances Offerings Request Marshaller
DescribeEventsResult Unmarshaller
Response Unmarshaller for DescribeDBEngineVersions operation
Delete D B Security Group Request Marshaller
Returns information about the RevokeDBSecurityGroupIngress response and response metadata.
Gets and sets the RevokeDBSecurityGroupIngressResult property.
Contains the result of a successful invocation of the RevokeDBSecurityGroupIngress
action.
Container for the parameters to the RestoreDBInstanceFromDBSnapshot operation.
Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up
to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database
except that the DB instance is created with the default DB security group.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the DBSnapshotIdentifier property
The value to set for the DBSnapshotIdentifier property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Sets the DBName property
The value to set for the DBName property
this instance
Sets the Engine property
The value to set for the Engine property
this instance
The identifier for the DB Snapshot to restore from. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive. Constraints: - Must contain from 1 to
255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two
consecutive hyphens
Example: my-snapshot-id
The compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.2xlarge |
db.m2.4xlarge
The port number on which the database accepts connections. Default: The same port as the original DB Instance Constraints: Value must be
1115-65535
The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You
cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
Specifies if the DB Instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
License model information for the restored DB Instance. Default: Same as source. Valid values: license-included |
bring-your-own-license | general-public-license
The database name for the restored DB Instance. This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source
Example: oracle-ee
AmazonRDS exception
Constructs a new InvalidDBInstanceStateException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the ReservedDBInstancesOfferings collection
The values to add to the ReservedDBInstancesOfferings collection
this instance
Adds elements to the ReservedDBInstancesOfferings collection
The values to add to the ReservedDBInstancesOfferings collection
this instance
A marker provided for paginated results.
A list of DB Instance offerings.
Returns information about the DescribeReservedDBInstancesOfferingsResult response and response metadata.
Gets and sets the DescribeReservedDBInstancesOfferingsResult property.
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Returns information about the DescribeEngineDefaultParameters response and response metadata.
Gets and sets the DescribeEngineDefaultParametersResult property.
Contains the result of a successful invocation of the DescribeEngineDefaultParameters
action.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the DBSnapshots collection
The values to add to the DBSnapshots collection
this instance
Adds elements to the DBSnapshots collection
The values to add to the DBSnapshots collection
this instance
The marker obtained from a previous operation response.
A list of DBSnapshot instances.
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
Adds elements to the DBSecurityGroups collection
The values to add to the DBSecurityGroups collection
this instance
The marker obtained from a previous operation response.
A list of DBSecurityGroup instances.
Contains the result of a successful invocation of the DescribeDBInstances action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the DBInstances collection
The values to add to the DBInstances collection
this instance
Adds elements to the DBInstances collection
The values to add to the DBInstances collection
this instance
The marker obtained from a previous operation response.
A list of DBInstance instances.
Container for the parameters to the DeleteDBSnapshot operation.
Deletes a DBSnapshot. NOTE:The DBSnapshot must be in the available state to be deleted.
Sets the DBSnapshotIdentifier property
The value to set for the DBSnapshotIdentifier property
this instance
The DBSnapshot identifier. Constraints: Must be the name of an existing DB Snapshot in the available state.
Returns information about the DeleteDBSecurityGroup response metadata.
The DeleteDBSecurityGroup operation has a void result type.
Container for the parameters to the DeleteDBInstance operation.
The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the
request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is
created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the SkipFinalSnapshot property
The value to set for the SkipFinalSnapshot property
this instance
Sets the FinalDBSnapshotIdentifier property
The value to set for the FinalDBSnapshotIdentifier property
this instance
The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive. Constraints: - Must contain from 1
to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two
consecutive hyphens
Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created.
If false is specified, a DB Snapshot is created before the DB Instance is deleted. The FinalDBSnapshotIdentifier parameter must be
specified if SkipFinalSnapshot is false. Default: false
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and
also setting the SkipFinalShapshot parameter to true results in an error. Constraints: - Must be 1 to 255 alphanumeric
characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
AmazonRDS exception
Constructs a new DBSecurityGroupQuotaExceededException with the specified error
message.
Describes the error encountered.
This data type is used as a response element in the following actions:
- ModifyDBInstance
- RebootDBInstance
- RestoreDBInstanceFromDBSnapshot
- RestoreDBInstanceToPointInTime
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the Status property
The value to set for the Status property
this instance
The name of the DB Security Group.
The status of the DB Security Group.
Container for the parameters to the AuthorizeDBSecurityGroupIngress operation.
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the
DBSecurityGroup if the application using the database is running on EC2 instances. Second, IP ranges are available if the application
accessing your database is running on the Internet. Required parameters for this API are one of CIDR range or (EC2SecurityGroupName AND
EC2SecurityGroupOwnerId). NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS
DB Instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the CIDRIP property
The value to set for the CIDRIP property
this instance
Sets the EC2SecurityGroupName property
The value to set for the EC2SecurityGroupName property
this instance
Sets the EC2SecurityGroupOwnerId property
The value to set for the EC2SecurityGroupOwnerId property
this instance
The name of the DB Security Group to authorize.
The IP range to authorize.
Name of the EC2 Security Group to authorize.
AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an
acceptable value.
Output structure for the UpateJob operation.
Sets the Success property
The value to set for the Success property
this instance
Sets the WarningMessage property
The value to set for the WarningMessage property
this instance
Specifies whether (true) or not (false) AWS Import/Export updated your
job.
An optional message notifying you of non-fatal issues with the job,
such as use of an incompatible Amazon S3 bucket name.
CancelJobResult Unmarshaller
Container for the parameters to the UpdateAccessKey operation.
Changes the status of the specified access key from Active to
Inactive, or vice versa. This action can be used to disable a User's
key as part of a key rotation workflow. If the
UserName field is not specified, the UserName is determined
implicitly based on the AWS Access Key ID used to sign the request.
Because this action works for access keys under the AWS Account, this
API can be used to manage root credentials even if the AWS Account has
no associated Users. For information about rotating keys,
see Managing Keys and Certificates in Using AWS Identity and Access
Management .
Sets the UserName property
The value to set for the UserName property
this instance
Sets the AccessKeyId property
The value to set for the AccessKeyId property
this instance
Sets the Status property
The value to set for the Status property
this instance
Name of the User whose key you want to update.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The Access Key ID of the Secret Access Key you want to update.
Constraints:
-
Length
16 - 32
-
Pattern
[\w]*
The status you want to assign to the Secret Access Key. Active means the key can be used for API calls to AWS, while Inactive
means the key cannot be used.
Constraints:
-
Allowed Values
Active, Inactive
Upload Signing Certificate Request Marshaller
Response Unmarshaller for ListServerCertificates operation
ListGroupsResult Unmarshaller
Delete Group Request Marshaller
Delete Group Policy Request Marshaller
Delete Account Alias Request Marshaller
Delete Access Key Request Marshaller
Container for the parameters to the PutGroupPolicy operation.
Adds (or updates) a policy document associated with the
specified group. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a group, see Limitations on IAM Entities in Using
AWS Identity and Access Management .
NOTE:Because policy documents can be large, you should
use POST rather than GET when calling PutGroupPolicy. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the PolicyDocument property
The value to set for the PolicyDocument property
this instance
Name of the group to associate the policy with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The policy document.
Constraints:
-
Length
1 - 131072
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Returns information about the ListServerCertificatesResult response and response metadata.
Gets and sets the ListServerCertificatesResult property.
Contains the result of a successful invocation of the ListServerCertificates action.
Container for the parameters to the ListAccountAliases operation.
Lists the account aliases associated with the account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
. You can paginate the results using the MaxItems
and Marker parameters.
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of account aliases you want in the response. If there are additional
account aliases beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
AmazonIdentityManagementService exception
Constructs a new InvalidAuthenticationCodeException with the specified error
message.
Describes the error encountered.
Returns information about the DeleteUserPolicy response metadata.
The DeleteUserPolicy operation has a void result type.
Returns information about the DeleteGroupPolicy response metadata.
The DeleteGroupPolicy operation has a void result type.
Returns information about the DeleteAccountAlias response metadata.
The DeleteAccountAlias operation has a void result type.
Returns information about the DeactivateMFADevice response metadata.
The DeactivateMFADevice operation has a void result type.
Container for the parameters to the CreateUser operation.
Creates a new User for your AWS Account. For
information about limitations on the number of Users you can create,
see Limitations on IAM Entities in Using AWS Identity and Access
Management .
Sets the Path property
The value to set for the Path property
this instance
Sets the UserName property
The value to set for the UserName property
this instance
The path for the User name. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management. This parameter is optional. If it is not included, it defaults to a slash
(/).
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
Name of the User to create.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the CreateGroup operation.
Creates a new group. For information about the
number of groups you can create, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
Sets the Path property
The value to set for the Path property
this instance
Sets the GroupName property
The value to set for the GroupName property
this instance
The path to the group. For more information about paths, see Identifiers for IAM
Entities in Using AWS Identity and Access Management. This parameter is optional. If it is not included, it defaults to a slash
(/).
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
Name of the group to create. Do not include the path in this value.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
BootstrapActionDetail Unmarshaller
Add Job Flow Steps Request Marshaller
Returns information about the TerminateJobFlows response metadata.
The TerminateJobFlows operation has a void result type.
Specification of a job flow step.
Sets the Name property
The value to set for the Name property
this instance
Sets the ActionOnFailure property
The value to set for the ActionOnFailure property
this instance
Sets the HadoopJarStep property
The value to set for the HadoopJarStep property
this instance
The name of the job flow step.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the action to take if the job flow step fails.
Constraints:
-
Allowed Values
TERMINATE_JOB_FLOW, CANCEL_AND_WAIT, CONTINUE
Specifies the JAR file used for the job flow step.
RegisterInstancesWithLoadBalancerResult Unmarshaller
DeleteLoadBalancerResult Unmarshaller
CreateLoadBalancerListenersResult Unmarshaller
AmazonElasticLoadBalancing exception
Constructs a new LoadBalancerNotFoundException with the specified error
message.
Describes the error encountered.
The Instance data type.
Default constructor for a new Instance object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Instance object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
Provides an EC2 instance ID.
Sets the InstanceId property
The value to set for the InstanceId property
this instance
Provides an EC2 instance ID.
Returns information about the DeleteLoadBalancerResult response and response metadata.
Gets and sets the DeleteLoadBalancerResult property.
The output for the DeleteLoadBalander action.
Returns information about the CreateLoadBalancerListenersResult response and response metadata.
Gets and sets the CreateLoadBalancerListenersResult property.
The output for the CreateLoadBalancerListeners action.
Implemenation for accessing AmazonElasticLoadBalancing.
Elastic Load Balancing Elastic Load Balancing is a cost-effective and easy to use web service to help you improve availability and
scalability of your application. It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load
Balancing enables availability through redundancy and supports traffic growth of your application.
Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID, AWS Secret Key and an
AmazonElasticLoadBalancingClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonElasticLoadBalancingClient Configuration Object
Creates a new LoadBalancer. Once the call has completed successfully, a new LoadBalancer is created; however, it will
not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or
not it is usable by using the DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService
.
NOTE: Currently, the client's quota of LoadBalancers is limited to five per Region. NOTE:
Load balancer DNS names vary depending on the Region they're created in. For load balancers created in the United States, the DNS name ends
with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For load
balancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com
Container for the necessary parameters to execute the CreateLoadBalancer service method on
AmazonElasticLoadBalancing.
The response from the CreateLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Deletes listeners from the LoadBalancer for the specified port.
Container for the necessary parameters to execute the DeleteLoadBalancerListeners service
method on AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.
Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the
instances for the LoadBalancer is returned. NOTE: The client must have created the specified input LoadBalancer in
order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.
Container for the necessary parameters to execute the DescribeInstanceHealth service method on
AmazonElasticLoadBalancing.
The response from the DescribeInstanceHealth service method, as returned by AmazonElasticLoadBalancing.
Deletes the specified LoadBalancer. If attempting to recreate the LoadBalancer, the client must reconfigure all the
settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of
the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to client instances. The client
will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created. To successfully call
this API, the client must provide the same account credentials as were used to create the LoadBalancer. NOTE: By
design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds.
Container for the necessary parameters to execute the DeleteLoadBalancer service method on
AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified
expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy,
the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it
first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified
in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the
cookie is based on the cookie expiration time, which is specified in the policy configuration.
Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.
The response from the CreateLBCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.
Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it
will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
Container for the necessary parameters to execute the CreateLoadBalancerListeners service
method on AmazonElasticLoadBalancing.
The response from the CreateLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.
Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns
configuration information for all LoadBalancers created by the caller. NOTE: The client must have created the specified
input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to
create the LoadBalancer.
Container for the necessary parameters to execute the DescribeLoadBalancers service method on
AmazonElasticLoadBalancing.
The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.
Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer. There
must be at least one Availability Zone registered with a LoadBalancer at all times. A client cannot remove all the Availability Zones from a
LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability
Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its
remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide
the same account credentials as those that were used to create the LoadBalancer.
Container for the necessary parameters to execute the
DisableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.
In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be
provided.
Container for the necessary parameters to execute the
DeregisterInstancesFromLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the DeregisterInstancesFromLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be
associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy,
except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in
the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application
cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application
cookie is issued. NOTE: An application client must receive and send two cookies: the application-generated cookie and
the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.
Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.
The response from the CreateAppCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.
Adds new instances to the LoadBalancer. Once the instance is registered, it starts receiving traffic and requests from
the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the
OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.
NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same
account credentials as those that were used to create the LoadBalancer. NOTE: Completion of this API does not guarantee
that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.
Container for the necessary parameters to execute the
RegisterInstancesWithLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the RegisterInstancesWithLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior
certificate that was used on the same LoadBalancer and port.
Container for the necessary parameters to execute the
SetLoadBalancerListenerSSLCertificate service method on AmazonElasticLoadBalancing.
The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by AmazonElasticLoadBalancing.
Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.
Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method
on AmazonElasticLoadBalancing.
The response from the DeleteLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.
Associates, updates, or disables a policy with a listener on the load balancer. Currently only zero (0) or one (1) policy can be
associated with a listener.
Container for the necessary parameters to execute the
SetLoadBalancerPoliciesOfListener service method on AmazonElasticLoadBalancing.
The response from the SetLoadBalancerPoliciesOfListener service method, as returned by AmazonElasticLoadBalancing.
Adds one or more EC2 Availability Zones to the LoadBalancer. The LoadBalancer evenly distributes requests across all
its registered Availability Zones that contain instances. As a result, the client must ensure that its LoadBalancer is appropriately scaled
for each registered Availability Zone. NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region
as the Availability Zones for which the LoadBalancer was created.
Container for the necessary parameters to execute the
EnableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.
The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.
Enables the client to define an application healthcheck for the instances.
Container for the necessary parameters to execute the ConfigureHealthCheck service method on
AmazonElasticLoadBalancing.
The response from the ConfigureHealthCheck service method, as returned by AmazonElasticLoadBalancing.
Response Unmarshaller for SwapEnvironmentCNAMEs operation
Response Unmarshaller for RetrieveEnvironmentInfo operation
Restart App Server Request Marshaller
Instance Unmarshaller
Response Unmarshaller for DeleteConfigurationTemplate operation
Check D N S Availability Request Marshaller
ApplicationDescription Unmarshaller
A specification identifying an individual configuration option.
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the OptionName property
The value to set for the OptionName property
this instance
A unique namespace identifying the option's associated AWS resource.
Constraints:
-
Length
1 - 255
The name of the configuration option.
Constraints:
-
Length
1 - 100
Result message wrapping a list of application version descriptions.
Adds elements to the ApplicationVersions collection
The values to add to the ApplicationVersions collection
this instance
Adds elements to the ApplicationVersions collection
The values to add to the ApplicationVersions collection
this instance
A list of ApplicationVersionDescription .
Returns information about the DeleteConfigurationTemplate response metadata.
The DeleteConfigurationTemplate operation has a void result type.
Container for the parameters to the CreateEnvironment operation.
Launches an environment for the specified application using the specified configuration.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the CNAMEPrefix property
The value to set for the CNAMEPrefix property
this instance
Sets the Description property
The value to set for the Description property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
Adds elements to the OptionsToRemove collection
The values to add to the OptionsToRemove collection
this instance
The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch
the most recently created application version.
Constraints:
-
Length
1 - 100
A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 23 characters in length. The name
can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the
specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not
specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
Constraints:
-
Length
4 - 23
The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue error. Conditional: You must specify either this parameter or a SolutionStackName, but not
both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS
Elastic Beanstalk returns a MissingRequiredParameter error.
Constraints:
-
Length
1 - 100
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default
values associated with the specified solution stack. Condition: You must specify either this or a TemplateName, but not both. If you
specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk
returns a MissingRequiredParameter error.
Constraints:
-
Length
0 - 100
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment
name.
Constraints:
-
Length
4 - 63
Describes this environment.
Constraints:
-
Length
0 - 200
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new
environment. These override the values obtained from the solution stack or the configuration template.
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
Returns information about the CreateApplicationVersionResult response and response metadata.
Gets and sets the CreateApplicationVersionResult property.
Result message wrapping a single description of an application version.
Returns information about the CheckDNSAvailabilityResult response and response metadata.
Gets and sets the CheckDNSAvailabilityResult property.
Indicates if the specified CNAME is available.
Sets the ResourceId property
ResourceId property
this instance
Checks if ResourceId property is set
true if ResourceId property is set
Sets the ResourceType property
ResourceType property
this instance
Checks if ResourceType property is set
true if ResourceType property is set
Sets the Key property
Key property
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
Value property
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the ResourceId property.
Gets and sets the ResourceType property.
Gets and sets the Key property.
Gets and sets the Value property.
Run Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if RunInstancesResult property is set
true if RunInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the RunInstancesResult property.
Run Instances Result
Resets an attribute of an instance to its default
value.
Sets the InstanceId property
ID of the instance on which the attribute will
be reset.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Attribute property
Name of the attribute to reset. Values are
"sourceDestCheck", "kernel" and "ramdisk".
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the InstanceId property.
ID of the instance on which the attribute will
be reset.
Gets and sets the Attribute property.
Name of the attribute to reset. Values are
"sourceDestCheck", "kernel" and "ramdisk".
Resets an attribute of an AMI to its default
value.
Note - The productCodes attribute cannot be reset.
Sets the ImageId property
ID of the AMI on which the attribute will be
reset
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the Attribute property
Specifies the attribute to reset
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the ImageId property.
ID of the AMI on which the attribute will be
reset
Gets and sets the Attribute property.
Specifies the attribute to reset
Reservation
Sets the ReservationId property
Unique ID of the reservation.
this instance
Checks if ReservationId property is set
true if ReservationId property is set
Sets the OwnerId property
AWS Access Key ID of the user who owns the
reservation
this instance
Checks if OwnerId property is set
true if OwnerId property is set
Sets the RequesterId property
ID of the requester.
this instance
Checks if RequesterId property is set
true if RequesterId property is set
Sets the GroupName property
Names of the security groups.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the RunningInstance property
Running instance
this instance
Checks if RunningInstance property is set
true if RunningInstance property is set
Gets and sets the ReservationId property.
Unique ID of the reservation.
Gets and sets the OwnerId property.
AWS Access Key ID of the user who owns the
reservation
Gets and sets the RequesterId property.
ID of the requester.
Gets and sets the GroupName property.
Names of the security groups.
Gets and sets the RunningInstance property.
Running instance
Region
Sets the RegionName property
Name of the region.
this instance
Checks if RegionName property is set
true if RegionName property is set
Sets the Endpoint property
Region service endpoint.
this instance
Checks if Endpoint property is set
true if Endpoint property is set
Gets and sets the RegionName property.
Name of the region.
Gets and sets the Endpoint property.
Region service endpoint.
Information returned by a ModifyInstanceAttribute
request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Launch Permission
Sets the UserId property
AWS Access Key ID.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the GroupName property
Name of the group. Currently supports "all."
this instance
Checks if GroupName property is set
true if GroupName property is set
Gets and sets the UserId property.
AWS Access Key ID.
Gets and sets the GroupName property.
Name of the group. Currently supports "all."
Sets the InternetGatewayId property
The ID of the Internet gateway.
this instance
Checks if InternetGatewayId property is set
true if InternetGatewayId property is set
Sets the Attachments property
A list of VPCs attached to the Internet gateway. Each VPC's
information is wrapped in an item element.
this instance
Checks if Attachments property is set
true if Attachments property is set
Sets the Tag property
A list of tags for the License.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the InternetGatewayId property.
The ID of the Internet gateway.
Gets and sets the Attachments property.
A list of VPCs attached to the Internet gateway. Each VPC's
information is wrapped in an item element.
Gets and sets the Tag property.
A list of tags for the License.
Information about the instance EBS block device.
Sets the VolumeId property
The ID of the Amazon EBS volume.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the Status property
Attachment state of the EBS volume.
this instance
Checks if Status property is set
true if Status property is set
Sets the AttachTime property
Time the volume was attached.
this instance
Checks if AttachTime property is set
true if AttachTime property is set
Sets the DeleteOnTermination property
Whether the volume will be deleted on instance
termination.
this instance
Checks if DeleteOnTermination property is set
true if DeleteOnTermination property is set
Gets and sets the VolumeId property.
The ID of the Amazon EBS volume.
Gets and sets the Status property.
Attachment state of the EBS volume.
Gets and sets the AttachTime property.
Time the volume was attached.
Gets and sets the DeleteOnTermination property.
Whether the volume will be deleted on instance
termination.
Information about the instance block device
mapping.
Sets the DeviceName property
The device name (e.g., /dev/sdh).
this instance
Checks if DeviceName property is set
true if DeviceName property is set
Sets the VirtualName property
The virtual device name.
this instance
Checks if VirtualName property is set
true if VirtualName property is set
Sets the Ebs property
Specifies parameters used to automatically
setup Amazon EBS volumes when the instance is launched.
this instance
Checks if Ebs property is set
true if Ebs property is set
Sets the NoDevice property
Specifies the device name (e.g., /dev/sdb) to
suppress during instance launch.
this instance
Checks if NoDevice property is set
true if NoDevice property is set
Gets and sets the DeviceName property.
The device name (e.g., /dev/sdh).
Gets and sets the VirtualName property.
The virtual device name.
Gets and sets the Ebs property.
Specifies parameters used to automatically
setup Amazon EBS volumes when the instance is launched.
Gets and sets the NoDevice property.
Specifies the device name (e.g., /dev/sdb) to
suppress during instance launch.
Details about the size of the image.
Sets the Size property
The size, in GB (2^30 bytes), of the Amazon EBS volume that will hold the converted image.
this instance
Checks if Size property is set
true if Size property is set
Gets and sets the Size property.
The size, in GB (2^30 bytes), of the Amazon EBS volume that will hold the converted image.
Details about the format of the image.
Sets the Format property
File format of the disk image.
this instance
Checks if Format property is set
true if Format property is set
Sets the Bytes property
Number of bytes in the disk image.
this instance
Checks if Bytes property is set
true if Bytes property is set
Sets the ImportManifestUrl property
The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about
creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the
Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
this instance
Checks if ImportManifestUrl property is set
true if ImportManifestUrl property is set
Gets and sets the Format property.
File format of the disk image.
Gets and sets the Bytes property.
Number of bytes in the disk image.
Gets and sets the ImportManifestUrl property.
The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about
creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the
Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
Request to describe historical pricing for Spot
Instances.
Sets the StartTime property
Start date and time of the Spot Instance price
history data.
this instance
Checks if StartTime property is set
true if StartTime property is set
Sets the EndTime property
End date and time of the Spot Instance price
history data.
this instance
Checks if EndTime property is set
true if EndTime property is set
Sets the InstanceType property
A list of instance types.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the ProductDescription property
A list of AMI descriptions
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified SpotPriceHistory.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Sets the AvailabilityZone property.
Filters the results by availability zone.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the MaxResults property.
Specifies the number of rows to return.
this instance
Checks if MaxResults property is set
true if MaxResults property is set
Sets the NextToken property.
Specifies the next set of rows to return.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the StartTime property.
Start date and time of the Spot Instance price
history data.
Gets and sets the EndTime property.
End date and time of the Spot Instance price
history data.
Gets and sets the InstanceType property.
A list of instance types.
Gets and sets the ProductDescription property.
A list of AMI descriptions
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified SpotPriceHistory.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Gets and sets the AvailabilityZone property.
Filters the results by availability zone.
Gets and sets the MaxResults property.
Specifies the number of rows to return.
Gets and sets the NextToken property.
Specifies the next set of rows to return.
Request to describe the data feed for Spot
Instances.
The Response for the
DescribeRouteTables operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeRouteTablesResult property is set
true if DescribeRouteTablesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeRouteTablesResult property.
DescribeRouteTables Result
Gives you information about the network ACLs in your VPC.You can filter the results to return information
only about ACLs that match criteria you specify. For example, you could get information only the ACL
associated with a particular subnet. The ACL must match at least one of the specified values for it to be
included in the results.
You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress
entry that denies traffic to a particular port). The result includes information for a particular ACL only if it
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Sets the NetworkAclId property
IDs of the route tables.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the Filter property
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the NetworkAclId property.
IDs of the route tables.
Gets and sets the Filter property.
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Bundle Tasks Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeBundleTasksResult property is set
true if DescribeBundleTasksResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeBundleTasksResult property.
Describe Bundle Tasks Result
Deletes a VPN gateway. Use this when you want to delete a VPC and all its
associated components because you no longer need them. We recommend that before you
delete a VPN gateway, you detach it from the VPC and delete the VPN
connection. Note that you don't need to delete the VPN gateway
if you just want to delete and re-create the VPN connection between your
VPC and data center.
AWS might delete any VPN gateway if you leave it inactive for an
extended period of time (inactive means that there's no VPN
connection in use with the VPN gateway).
Sets the VpnGatewayId property
The ID of the VPN gateway you want to delete.
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Gets and sets the VpnGatewayId property.
The ID of the VPN gateway you want to delete.
Request to delete the data feed for Spot
Instances.
Deletes a PlacementGroupfrom a user's account.
Terminate all Amazon EC2 instances in the placement group before
deletion.
Sets the GroupName property
The name of the PlacementGroup to delete.
this instance
Checks if GroupName property is set
true if GroupName property is set
Gets and sets the GroupName property.
The name of the PlacementGroup to delete.
Deletes the specified key pair, by removing the
public key from Amazon EC2. You must own the key pair.
Sets the KeyName property
Name of the key pair to delete.
this instance
Checks if KeyName property is set
true if KeyName property is set
Gets and sets the KeyName property.
Name of the key pair to delete.
Deletes a customer gateway. You must delete the
VPN connection before deleting the customer gateway.
AWS might delete any customer gateway if you leave it inactive for an
extended period of time (inactive means that there's no VPN connection in
use with the customer gateway).
Sets the CustomerGatewayId property
The ID of the customer gateway you want to
delete.
this instance
Checks if CustomerGatewayId property is set
true if CustomerGatewayId property is set
Gets and sets the CustomerGatewayId property.
The ID of the customer gateway you want to
delete.
Deactivates a license.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Vpc Result
Checks if Vpc property is set
true if Vpc property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Vpc property.
VPC
Create Subnet Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateSubnetResult property is set
true if CreateSubnetResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateSubnetResult property.
Create Subnet Result
Request to create the data feed for Spot
Instances, enabling you to view Spot Instance
usage logs. You can create one data feed per account.
Sets the Bucket property
The Amazon S3 bucket in which to store the
Spot Instance datafeed.
Constraints: Must be a valid bucket
assocaited with your account.
this instance
Checks if Bucket property is set
true if Bucket property is set
Sets the Prefix property
Prefix that is prepended to datafeed files.
this instance
Checks if Prefix property is set
true if Prefix property is set
Gets and sets the Bucket property.
The Amazon S3 bucket in which to store the
Spot Instance datafeed.
Constraints: Must be a valid bucket
assocaited with your account.
Gets and sets the Prefix property.
Prefix that is prepended to datafeed files.
The Response for the
CreateInternetGateway operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateInternetGatewayResult property is set
true if CreateInternetGatewayResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateInternetGatewayResult property.
CreateInternetGateway Result
Create Dhcp Options Result
Checks if DhcpOptions property is set
true if DhcpOptions property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the DhcpOptions property.
Dhcp options
Bundle Instance Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if BundleInstanceResult property is set
true if BundleInstanceResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the BundleInstanceResult property.
Bundle Instance Result
Bundles the Windows instance. This procedure is not applicable for Linux
and UNIX instances. For more information, go to the Amazon Elastic Compute
Cloud Developer Guide or Amazon Elastic Compute Cloud Getting Started Guide.
Sets the InstanceId property
The ID of the instance to bundle.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Storage property
Storage
this instance
Checks if Storage property is set
true if Storage property is set
Gets and sets the InstanceId property.
The ID of the instance to bundle.
Gets and sets the Storage property.
Storage
Attaches an Amazon EBS volume to a running
instance and exposes it as the
specified device.
Windows instances currently support devices xvda through xvdp. Devices
xvda and xvdb are reserved by the operating system, xvdc is
assigned to drive C:\, and, depending on the instance type, devices xvdd through
xvde might be reserved by the instance stores. Any device that is not
reserved can be attached to an Amazon EBS volume. For a list of
devices that are reserved by the instance stores, go to the Amazon
Elastic Compute Cloud Developer Guide.
Sets the VolumeId property
The ID of the Amazon EBS volume. The volume
and instance must be within
the same Availability Zone and the
instance must be running.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Sets the InstanceId property
The ID of the instance to which the volume
attaches. The volume and
instance must be within the same
Availability Zone and the instance
must be running.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Device property
Specifies how the device is exposed to the
instance (e.g., /dev/sdh).
this instance
Checks if Device property is set
true if Device property is set
Gets and sets the VolumeId property.
The ID of the Amazon EBS volume. The volume
and instance must be within
the same Availability Zone and the
instance must be running.
Gets and sets the InstanceId property.
The ID of the instance to which the volume
attaches. The volume and
instance must be within the same
Availability Zone and the instance
must be running.
Gets and sets the Device property.
Specifies how the device is exposed to the
instance (e.g., /dev/sdh).
AssociateAddress Result
Checks if AssociationId property is set
true if AssociationId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the AssociationId property.
ID that AWS provides to represent the association of the address
with an instance. Returned only for VPC elastic IP addresses.
Activates a license.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
ListMetricsResult Unmarshaller
Response Unmarshaller for DescribeAlarmHistory operation
Container for the parameters to the SetAlarmState operation.
Temporarily sets the state of an alarm. When the updated
StateValue differs from the previous value, the action
configured for the appropriate state is invoked. This is not a
permanent change. The next periodic alarm check (in about a minute)
will set the alarm to its actual state.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the StateValue property
The value to set for the StateValue property
this instance
Sets the StateReason property
The value to set for the StateReason property
this instance
Sets the StateReasonData property
The value to set for the StateReasonData property
this instance
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
Constraints:
-
Length
1 - 255
The value of the state.
Constraints:
-
Allowed Values
OK, ALARM, INSUFFICIENT_DATA
The reason that this alarm is set to this specific state (in human-readable text format)
Constraints:
-
Length
0 - 1023
The reason that this alarm is set to this specific state (in machine-readable JSON format)
Constraints:
-
Length
0 - 4000
Returns information about the ListMetricsResult response and response metadata.
Gets and sets the ListMetricsResult property.
The output for the ListMetrics action.
The output for the DescribeAlarmHistory action.
Adds elements to the AlarmHistoryItems collection
The values to add to the AlarmHistoryItems collection
this instance
Adds elements to the AlarmHistoryItems collection
The values to add to the AlarmHistoryItems collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of alarm histories in JSON format.
A string that marks the start of the next batch of returned results.
The SetDistributionConfigResponse contains the distribution's modified
information structure along with any other headers returned by
CloudFront.
The GetDistributionInfoResponse contains all the information about the
GetDistributionInfo operation and any headers returned by CloudFront.
Gets and sets the Distribution property.
This contains all the information (including the configuration) for a
cloudfront distribution.
Gets and sets the ETag property.
The Distribution's ETag is also set if
possible.
Gets and sets the ETag property.
The ListDistributionsRequest contains the parameters used for the ListDistributions operation.
All parameters to this request object are optional.
Sets the Marker property for this request.
All keys returned will be lexiographically after the marker.
the value that Marker is set to
this instance
Sets the MaxItems property for this request.
Limits the result set of keys to MaxItems.
the value that MaxItems is set to
this instance
Gets and sets the Marker property.
All keys returned will be lexiographically after the marker.
Gets and sets the MaxItems property.
Limits the result set of keys to MaxItems.
The DeleteOriginAccessIdentityRequest contains the parameters used for the DeleteOriginAccessIdentity operation.
Required Parameters: Id
Required Parameters: ETag
Sets the Id property of this request to the value passed in.
The OriginAccessIdentity's id
The request with the Id property set
Sets the ETag property of this request to the value passed in.
The OriginAccessIdentity's etag
The request with the ETag property set
Gets and sets the Id property for the OriginAccessIdentity
Gets and sets the ETag property for the OriginAccessIdentity
StackResource Unmarshaller
List Stack Resources Request Marshaller
DescribeStacksResult Unmarshaller
DescribeStackEventsResult Unmarshaller
The StackEvent data type.
Sets the StackId property
The value to set for the StackId property
this instance
Sets the EventId property
The value to set for the EventId property
this instance
Sets the StackName property
The value to set for the StackName property
this instance
Sets the LogicalResourceId property
The value to set for the LogicalResourceId property
this instance
Sets the PhysicalResourceId property
The value to set for the PhysicalResourceId property
this instance
Sets the ResourceType property
The value to set for the ResourceType property
this instance
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the ResourceStatus property
The value to set for the ResourceStatus property
this instance
Sets the ResourceStatusReason property
The value to set for the ResourceStatusReason property
this instance
Sets the ResourceProperties property
The value to set for the ResourceProperties property
this instance
The unique ID name of the instance of the stack.
The unique ID of this event.
The name associated with a stack.
The logical name of the resource specified in the template.
The name or unique identifier associated with the physical instance of the resource.
Type of the resource. (For more information, go to the AWS
CloudFormation User Guide.)
Time the status was updated.
Current status of the resource.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
Success/failure message associated with the resource.
BLOB of the properties used to create the resource.
Container for the parameters to the ListStackResources operation.
Returns descriptions for all resources of the specified stack. For deleted stacks, ListStackResources returns resource
information for up to 90 days after the stack has been deleted.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The name or the unique identifier associated with the stack. Default: There is no default value.
String that identifies the start of the next list of events, if there is one.
Default: There is no default value.
Constraints:
-
Length
1 - 1024
The output for GetTemplate action.
Sets the TemplateBody property
The value to set for the TemplateBody property
this instance
Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)
Constraints:
-
Length
1 -
Returns information about the DescribeStacksResult response and response metadata.
Gets and sets the DescribeStacksResult property.
The output for a DescribeStacks action.
The output for a CreateStack action.
Sets the StackId property
The value to set for the StackId property
this instance
Unique identifier of the stack.
Put Notification Configuration Request Marshaller
Describe Policies Request Marshaller
DescribeAutoScalingInstancesResult Unmarshaller
Response Unmarshaller for DescribeAutoScalingInstances operation
Container for the parameters to the EnableMetricsCollection operation.
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled
metrics with the Metrics parameter. Auto scaling metrics collection can be turned on only if the
InstanceMonitoring.Enabled flag, in the Auto Scaling group's launch configuration, is set to true .
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Sets the Granularity property
The value to set for the Granularity property
this instance
The name or ARN of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:
- GroupMinSize
- GroupMaxSize
- GroupDesiredCapacity
- GroupInServiceInstances
- GroupPendingInstances
- GroupTerminatingInstances
- GroupTotalInstances
The granularity to associate with the metrics to collect. Currently, the only legal granularity is "1Minute".
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the DescribeScheduledActions operation.
Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of action already executed, see
the activity record returned in DescribeScalingActivities.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the ScheduledActionNames collection
The values to add to the ScheduledActionNames collection
this instance
Adds elements to the ScheduledActionNames collection
The values to add to the ScheduledActionNames collection
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the EndTime property
The value to set for the EndTime property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled
actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown
scheduled actions are requested, they are ignored with no error.
The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.
The latest scheduled start time to return. If scheduled action names are provided, this field will be ignored.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The maximum number of scheduled actions to return.
Constraints:
-
Range
1 - 50
Container for the parameters to the DescribeScalingActivities operation.
Returns the scaling activities for the specified Auto Scaling group. If the specified ActivityIds list is
empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress
appear first on the list. This action supports pagination. If the response includes a token, there are more records
available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Adds elements to the ActivityIds collection
The values to add to the ActivityIds collection
this instance
Adds elements to the ActivityIds collection
The values to add to the ActivityIds collection
this instance
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an
AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items.
If unknown activities are requested, they are ignored with no error.
The name of the AutoScalingGroup.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The maximum number of scaling activities to return.
Constraints:
-
Range
1 - 50
A string that marks the start of the next batch of returned results for pagination.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
AmazonAutoScaling exception
Constructs a new AlreadyExistsException with the specified error
message.
Describes the error encountered.
Information returned by the CreateQueueRequest, including queue URL.
Checks if QueueUrl property is set
true if QueueUrl property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
AmazonSQSClient is an implementation of AmazonSQS;
the client allows you to manage your AmazonSQS resources.
If you want to use the AmazonSQSClient from a Medium Trust
hosting environment, please create the client with an
AmazonSQSConfig object whose UseSecureStringForAwsSecretKey
property is false.
Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable hosted queue for storing
messages as they travel between computers. By using Amazon SQS, developers can simply move data between
distributed application components performing different tasks, without losing messages or requiring each
component to be always available. Amazon SQS works by exposing Amazon's web-scale messaging infrastructure
as a web service. Any computer on the Internet can add or read messages without any installed software or
special firewall configurations. Components of applications using Amazon SQS can run independently, and do
not need to be on the same network, developed with the same technologies, or running at the same time.
Implements the Dispose pattern for the AmazonSQSClient
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an
AmazonSQS Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonSQS Configuration Object
Constructs an AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an
AmazonSQS Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The AmazonSQS Configuration Object
Create Queue
Create Queue request
Create Queue Response from the service
The CreateQueue action creates a new queue, or returns the URL of an existing one.
When you request CreateQueue, you provide a name for the queue. To successfully create
a new queue, you must provide a name that is unique within the scope of your own queues.
If you provide the name of an existing queue, a new queue isn't created and an error
isn't returned. Instead, the request succeeds and the queue URL for the existing queue is
returned. Exception: if you provide a value for DefaultVisibilityTimeout that is different
from the value for the existing queue, you receive an error.
List Queues
List Queues request
List Queues Response from the service
The ListQueues action returns a list of your queues.
Add Permission
Add Permission request
Add Permission Response from the service
Adds the specified permission(s) to a queue for the specified principal(s). This allows for sharing access to the queue.
Change Message Visibility
Change Message Visibility request
Change Message Visibility Response from the service
The ChangeMessageVisibility action extends the read lock timeout of the specified message from the specified queue to the specified value.
Delete Message
Delete Message request
Delete Message Response from the service
The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.
Delete Queue
Delete Queue request
Delete Queue Response from the service
This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.
Get Queue Attributes
Get Queue Attributes request
Get Queue Attributes Response from the service
Gets one or all attributes of a queue. Queues currently have two attributes you can get: ApproximateNumberOfMessages and VisibilityTimeout.
Remove Permission
Remove Permission request
Remove Permission Response from the service
Removes the permission with the specified statement id from the queue.
Receive Message
Receive Message request
Receive Message Response from the service
Retrieves one or more messages from the specified queue. For each message returned, the response includes
the message body; MD5 digest of the message body; receipt handle, which is the identifier you must provide
when deleting the message; and message ID of each message. Messages returned by this action stay in the queue
until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned
on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a
VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.
Send Message
Send Message request
Send Message Response from the service
The SendMessage action delivers a message to the specified queue.
Set Queue Attributes
Set Queue Attributes request
Set Queue Attributes Response from the service
Sets an attribute of a queue. Currently, you can set only the VisibilityTimeout attribute for a queue.
Configure HttpClient with set of defaults as well as configuration
from AmazonSQSConfig instance
Invoke request and return response
Look for additional error strings in the response and return formatted exception
Exponential sleep on failed request
Add authentication related and version parameters
Convert CreateQueueRequest to name value pairs
Convert ListQueuesRequest to name value pairs
Convert ChangeMessageVisibilityRequest to name value pairs
Convert DeleteMessageRequest to name value pairs
Convert DeleteQueueRequest to name value pairs
Convert GetQueueAttributesRequest to name value pairs
Convert ReceiveMessageRequest to name value pairs
Convert SendMessageRequest to name value pairs
Convert SetQueueAttributesRequest to name value pairs
Convert AddPermissionRequest to name value pairs
Convert RemovePermissionRequest to name value pairs
Encapsulates the metadata and result of the ListSubscriptionsByTopic action.
Checks if ListSubscriptionsByTopicResult property is set
true if ListSubscriptionsByTopicResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ListSubscriptionsByTopicResult property.
Encapsulates the result of the ListSubscriptionsByTopic action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns
a limited list of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
Sets the TopicArn property
The ARN of the topic for which you wish to find subscriptions.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the NextToken property
Token returned by the previous ListSubscriptionsByTopic request.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the TopicArn property.
The ARN of the topic for which you wish to find subscriptions.
Gets and sets the NextToken property.
Token returned by the previous ListSubscriptionsByTopic request.
Returns any errors in the request.
Checks if Error property is set
true if Error property is set
Checks if RequestId property is set
true if RequestId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Error property.
Error associated with the request.
Gets and sets the RequestId property.
The ID associated with the request. Be sure to reference this ID when contacting AWS support.
Encapsulates the result of the CreateTopic action.
Checks if TopicArn property is set
true if TopicArn property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the TopicArn property.
The Amazon Resource Name (ARN) assigned to the created topic.
Encapsulates the result of the ConfirmSubscription action.
Checks if SubscriptionArn property is set
true if SubscriptionArn property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SubscriptionArn property.
The ARN of the created subscription.
Amazon Simple Notification Service Exception provides details of errors
returned by Amazon Simple Notification Service service
Initializes a new AmazonSimpleNotificationServiceException with default values.
Initializes a new AmazonSimpleNotificationServiceException with a specified
error message
A message that describes the error
Initializes a new AmazonSimpleNotificationServiceException with a specified error message
and HTTP status code
A message that describes the error
HTTP status code for error response
Initializes a new AmazonSimpleNotificationServiceException from the inner exception that is
the cause of this exception.
The nested exception that caused the AmazonSimpleNotificationServiceException
Initializes a new AmazonSimpleNotificationServiceException with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Serializes this instance of AmazonSimpleNotificationServiceException.
The object that holds the serialized object data.
The contextual information about the source or destination.
Constructs AmazonSimpleNotificationServiceException with message and wrapped exception
A message that describes the error
The nested exception that caused the AmazonS3Exception
Initializes an AmazonSimpleNotificationServiceException with error information provided in an
AmazonSimpleNotificationService response.
A message that describes the error
HTTP status code for error response
Error Code returned by the service
Error type. Possible types: Sender, Receiver or Unknown
Request ID returned by the service
Compete xml found in response
Gets and sets of the ErrorCode property.
Gets and sets of the ErrorType property.
Gets error message
Gets status code returned by the service if available. If status
code is set to -1, it means that status code was unavailable at the
time exception was thrown
Gets XML returned by the service if available.
Gets Request ID returned by the service if available.
Returns information about the SendRawEmailResult response and response metadata.
Gets and sets the SendRawEmailResult property.
Represents a unique message ID returned from a successful SendRawEmail request.
Represents a list of SendDataPoint items returned from a
successful GetSendStatistics request. This list contains
aggregated data from the previous two weeks of sending
activity.
Adds elements to the SendDataPoints collection
The values to add to the SendDataPoints collection
this instance
Adds elements to the SendDataPoints collection
The values to add to the SendDataPoints collection
this instance
Describes the condition used to perform a conditional PutAttributes
or conditional DeleteAttributes.
Sets the Name property
The name of the attribute used for the conditional check.
this instance
Checks if Name property is set
true if Name property is set
Sets the Value property
The value of the attribute used for the conditional check.
this instance
Checks if Value property is set
true if Value property is set
Sets the Exists property
Check for the existence of the attribute used for the conditional check.
If this field is unspecified or true, UpdateCondition.Value must be set to a value.
If this field is false, UpdateCondition.Value should not have a value assigned to it.
If no value is associated with this field, SimpleDB uses a default value of 'true'
this instance
Checks if Exists property is set
true if Exists property is set
Gets and sets the Name property.
The name of the attribute used for the conditional check.
Gets and sets the Value property.
The value of the attribute used for the conditional check.
Gets and sets the Exists property.
Check for the existence of the attribute used for the conditional check.
If this field is unspecified or true, UpdateCondition.Value must be set to a value.
If this field is false, UpdateCondition.Value should not have a value assigned to it.
If no value is associated with this field, SimpleDB uses a default value of 'true'
Items represent individual objects that contain one or more attribute name-value pairs.
Sets the Name property
The name of the item.
this instance
Checks if Name property is set
true if Name property is set
Sets the NameEncoding property
The encoding for the item's name. For example: base64
this instance
Checks if NameEncoding property is set
true if NameEncoding property is set
Sets the Attribute property
Attribute associated with an Item.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the Name property.
The name of the item.
Gets and sets the NameEncoding property.
The encoding for the item's name. For example: base64
Gets and sets the Attribute property.
Attribute associated with an Item.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Represents an S3 Object. Contains all attributes that an S3 Object has.
For more information about S3 Objects refer:
Returns a System.String that represents the S3Object.
A System.String representation of the S3Object.
Checks if Key property is set.
true if Key property is set.
Checks if BucketName property is set.
true if BucketName property is set.
Checks if LastModified property is set.
true if LastModified property is set.
Checks if ETag property is set.
true if ETag property is set.
Checks if Owner property is set.
true if Owner property is set.
Checks if StorageClass property is set.
true if StorageClass property is set.
Gets and sets the Key property.
Gets and sets the BucketName property.
This is the name of the S3 Bucket in which the
key is stored.
Gets and sets the LastModified property.
Date retrieved from S3 is in ISO8601 format.
GMT formatted date is passed back to the user.
Gets and sets the ETag property.
Gets and sets the Size property.
Gets and sets the Owner property.
Gets and sets the StorageClass property.
The PutObjectResponse contains any headers returned by S3.
Gets and sets the ETag property.
Gets and sets the VersionId property.
This is the version-id of the S3 object
Gets and sets the Headers property.
The PutBucketRequest contains the parameters used for the PutBucket operation.
The BucketRegion parameter is used if you wish to specify the bucket locality.
Required Parameters: BucketName
Optional Parameters: BucketRegion, Default - S3Region.US
Sets the BucketName property for this request.
This is the S3 Bucket that will be created by this request.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the BucketRegion property for this request.
When set, this will determine where your data will
reside in S3. Refer
for a list of possible values.
The value that BucketRegion is set to
the request with the BucketRegion set
Alternative to setting bucket region by using the region's name.
When set, this will determine where your data will
reside in S3.
Valid values: us-east-1, us-west-1, eu-west-1, ap-southeast-1, ap-northeast-1
The value that BucketRegionName is set to
the request with the BucketRegionName set
Gets and sets the BucketName property.
Gets and sets the BucketRegion property.
Refer
for a list of possible values.
Default: S3Region.US
Alternative to setting bucket region by using the region's name.
When set, this will determine where your data will
reside in S3.
Valid values: us-east-1, us-west-1, eu-west-1, ap-southeast-1, ap-northeast-1
A S3Grantee represents an Owner/User/Group that can be given permissions
on a bucket or object.
For more information about Grantees or ACLs see:
Returns a System.String that represents the Grantee Object.
A System.String representation of the Grantee Object.
Determines whether two Tuple objects have the same value.
true if obj is a String and its value is the same as this instance; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current S3Grantee
Determines whether is specified Grantee is equal to the current Grantee.
The specified Grantee
true if the Grantees are equal, false otherwise
Sets the CanonicalUser property.
DisplayName of Canonical User
ID of Canonical User
this instance
Checks if the CanonicalUser property is set.
true if the CanonicalUser property is set.
Sets the EmailAddress property.
EmailAddress property
this instance
Checks if EmailAddress property is set.
true if EmailAddress property is set.
Sets the URI property.
URI property
this instance
Checks if URI property is set.
true if URI property is set.
Gets and Sets the CanonicalUser property.
Gets and sets the EmailAddress property.
Gets and sets the URI property.
The DeleteBucketRequest contains the parameters used for the DeleteBucket operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket that you want to delete.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
Represents an S3 Bucket Object Version. An S3 Object version is an S3 object
that also has a VersionId, whether this is the Latest version of the object
and if its a DeleteMarker or not.
Returns a System.String that represents the S3Object.
A System.String representation of the S3Object.
Gets and sets the VersionId property.
Gets and Sets the IsLatest property.
Specifies whether the object is (true) or
is not (false) the latest version of an object.
Gets and Sets the IsDeleteMarker property.
Specifies whether the object is (true) or
is not (false) the latest version of an object.
The GetNotificationConfigurationRequest contains the parameters used for the GetNotificationConfiguration operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
Signs the specified request with the AWS3 signing protocol by using the
AWS account credentials given in the method parameters.
The AWS public key
The AWS secret key used to sign the request in clear text
The configuration that specifies which hashing algorithm to use
The request to have the signature compute for
The AWS secret key stored in a secure string
If any problems are encountered while signing the request
Result Unmarshaller for RestoreDBInstanceToPointInTime operation
Response Unmarshaller for RestoreDBInstanceToPointInTime operation
Restore D B Instance From D B Snapshot Request Marshaller
OrderableDBInstanceOption Unmarshaller
DescribeDBSnapshotsResult Unmarshaller
DescribeDBParametersResult Unmarshaller
Delete D B Instance Request Marshaller
DBSecurityGroup Unmarshaller
Result Unmarshaller for AuthorizeDBSecurityGroupIngress operation
AmazonRDS exception
Constructs a new InvalidDBParameterGroupStateException with the specified error
message.
Describes the error encountered.
This data type is used as a response element in the following actions:
- AuthorizeDBSecurityGroupIngress
- DescribeDBSecurityGroups
- RevokeDBSecurityGroupIngress
Sets the Status property
The value to set for the Status property
this instance
Sets the EC2SecurityGroupName property
The value to set for the EC2SecurityGroupName property
this instance
Sets the EC2SecurityGroupOwnerId property
The value to set for the EC2SecurityGroupOwnerId property
this instance
Provides the status of the EC2 security group.
Specifies the name of the EC2 Security Group.
Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
Adds elements to the OrderableDBInstanceOptions collection
The values to add to the OrderableDBInstanceOptions collection
this instance
Adds elements to the OrderableDBInstanceOptions collection
The values to add to the OrderableDBInstanceOptions collection
this instance
Sets the Marker property
The value to set for the Marker property
this instance
An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.
A marker that can be used to retrieve paginated results.
Returns information about the DescribeDBSecurityGroupsResult response and response metadata.
Gets and sets the DescribeDBSecurityGroupsResult property.
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
The status of the DB Parameter Group. This data type is used as a response element in the following actions:
- CreateDBInstance
- CreateDBInstanceReadReplica
- DeleteDBInstance
- ModifyDBInstance
- RebootDBInstance
- RestoreDBInstanceFromDBSnapshot
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the ParameterApplyStatus property
The value to set for the ParameterApplyStatus property
this instance
The name of the DP Parameter Group.
The status of parameter updates.
Container for the parameters to the CreateDBSecurityGroup operation.
Creates a new database security group. Database Security groups control access to a database instance.
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
Sets the DBSecurityGroupDescription property
The value to set for the DBSecurityGroupDescription property
this instance
The name for the DB Security Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric
characters or hyphens. Must not be "Default". Example: mysecuritygroup
The description for the DB Security Group.
AmazonImportExport exception
Constructs a new UnableToUpdateJobIdException with the specified error
message.
Describes the error encountered.
GetStatusResult Unmarshaller
Response Unmarshaller for CreateJob operation
AmazonImportExport exception
Constructs a new NoSuchBucketException with the specified error
message.
Describes the error encountered.
Returns information about the ListJobsResult response and response metadata.
Gets and sets the ListJobsResult property.
Output structure for the ListJobs operation.
AmazonImportExport exception
Constructs a new InvalidCustomsException with the specified error
message.
Describes the error encountered.
Implemenation for accessing AmazonImportExport.
AWS Import/Export Service AWS Import/Export accelerates
transferring large amounts of data between the AWS cloud and portable
storage devices that you mail to us. AWS Import/Export transfers data
directly onto and off of your storage devices using Amazon's
high-speed internal network and bypassing the Internet. For large data
sets, AWS Import/Export is often faster than Internet transfer and
more cost effective than upgrading your connectivity.
Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonImportExportClient with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonImportExportClient Configuration Object
This operation initiates the process of scheduling an upload or
download of your data. You include in the request a manifest that
describes the data transfer specifics. The response to the request
includes a job ID, which you can use in other operations, a signature
that you use to identify your storage device, and the address where
you should ship your storage device.
Container for the necessary parameters
to execute the CreateJob service method on AmazonImportExport.
The response from the CreateJob service method, as returned
by AmazonImportExport.
This operation cancels a specified job. Only the job owner can
cancel it. The operation fails if the job has already started or is
complete.
Container for the necessary parameters
to execute the CancelJob service method on AmazonImportExport.
The response from the CancelJob service method, as returned
by AmazonImportExport.
This operation returns information about a job, including where
the job is in the processing pipeline, the status of the results, and
the signature value associated with the job. You can only return
information about jobs you own.
Container for the necessary parameters
to execute the GetStatus service method on AmazonImportExport.
The response from the GetStatus service method, as returned
by AmazonImportExport.
This operation returns the jobs associated with the requester.
AWS Import/Export lists the jobs in reverse chronological order based
on the date of creation. For example if Job Test1 was created
2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation
would return Test2 followed by Test1.
Container for the necessary parameters
to execute the ListJobs service method on AmazonImportExport.
The response from the ListJobs service method, as returned by
AmazonImportExport.
You use this operation to change the parameters specified in
the original manifest file by supplying a new manifest file. The
manifest file attached to this request replaces the original manifest
file. You can only use the operation after a CreateJob request but
before the data transfer starts and you can only use it on jobs you
own.
Container for the necessary parameters
to execute the UpdateJob service method on AmazonImportExport.
The response from the UpdateJob service method, as returned
by AmazonImportExport.
UploadSigningCertificateResult Unmarshaller
Put User Policy Request Marshaller
MFADevice Unmarshaller
Response Unmarshaller for ListSigningCertificates operation
GetUserResult Unmarshaller
Get Login Profile Request Marshaller
Response Unmarshaller for GetGroupPolicy operation
Enable M F A Device Request Marshaller
Response Unmarshaller for DeleteLoginProfile operation
Create Login Profile Request Marshaller
Contains the result of a successful invocation of the ListUsers
action.
Adds elements to the Users collection
The values to add to the Users collection
this instance
Adds elements to the Users collection
The values to add to the Users collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of User names.
A flag that indicates whether there are more User names to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more Users in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Contains the result of a successful invocation of the
ListUserPolicies action.
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of policy names.
A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more policy names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the ListMFADevicesResult response and response metadata.
Gets and sets the ListMFADevicesResult property.
Contains the result of a successful invocation of the ListMFADevices action.
Returns information about the GetGroupPolicyResult response and response metadata.
Gets and sets the GetGroupPolicyResult property.
Contains the result of a successful invocation of the GetGroupPolicy action.
AmazonIdentityManagementService exception
Constructs a new EntityTemporarilyUnmodifiableException with the specified error
message.
Describes the error encountered.
Contains the result of a successful invocation of the CreateUser
action.
Sets the User property
The value to set for the User property
this instance
Information about the User.
Returns information about the CreateGroupResult response and response metadata.
Gets and sets the CreateGroupResult property.
Contains the result of a successful invocation of the CreateGroup action.
PlacementType Unmarshaller
Returns information about the DescribeJobFlowsResult response and response metadata.
Gets and sets the DescribeJobFlowsResult property.
The output for the DescribeJobFlows operation.
DisableAvailabilityZonesForLoadBalancerResult Unmarshaller
Container for the parameters to the SetLoadBalancerListenerSSLCertificate operation.
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior
certificate that was used on the same LoadBalancer and port.
Default constructor for a new SetLoadBalancerListenerSSLCertificateRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new SetLoadBalancerListenerSSLCertificateRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name of the the LoadBalancer.
The port that uses the specified SSL certificate.
The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS
Identity and Access Management documentation.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the LoadBalancerPort property
The value to set for the LoadBalancerPort property
this instance
Sets the SSLCertificateId property
The value to set for the SSLCertificateId property
this instance
The name of the the LoadBalancer.
The port that uses the specified SSL certificate.
The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS
Identity and Access Management documentation.
The Listener data type.
Default constructor for a new Listener object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Listener object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
Specifies the LoadBalancer transport protocol to use for routing - TCP or HTTP. This property cannot be modified for
the life of the LoadBalancer.
Specifies the external LoadBalancer port number. This property cannot be modified for the life of the
LoadBalancer.
Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life
of the LoadBalancer.
Sets the Protocol property
The value to set for the Protocol property
this instance
Sets the LoadBalancerPort property
The value to set for the LoadBalancerPort property
this instance
Sets the InstancePort property
The value to set for the InstancePort property
this instance
Sets the SSLCertificateId property
The value to set for the SSLCertificateId property
this instance
Specifies the LoadBalancer transport protocol to use for routing - TCP or HTTP. This property cannot be modified for the life of the
LoadBalancer.
Specifies the external LoadBalancer port number. This property cannot be modified for the life of the LoadBalancer.
Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the LoadBalancer.
Constraints:
-
Range
1 - 65535
The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Keys and Certificates in
the AWS Identity and Access Management documentation.
The output for the DeleteLoadBalander action.
Container for the parameters to the CreateLoadBalancerListeners operation.
Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it
will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
Default constructor for a new CreateLoadBalancerListenersRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new CreateLoadBalancerListenersRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name of the new LoadBalancer. The name must be unique within your AWS account.
A list of LoadBalancerPort, InstancePort, Protocol, and SSLCertificateId items.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
The name of the new LoadBalancer. The name must be unique within your AWS account.
A list of LoadBalancerPort, InstancePort, Protocol, and SSLCertificateId items.
Container for the parameters to the ConfigureHealthCheck operation.
Enables the client to define an application healthcheck for the instances.
Default constructor for a new ConfigureHealthCheckRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new ConfigureHealthCheckRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The mnemonic name associated with the LoadBalancer. This name must be unique within the client AWS account.
A structure containing the configuration information for the new healthcheck.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the HealthCheck property
The value to set for the HealthCheck property
this instance
The mnemonic name associated with the LoadBalancer. This name must be unique within the client AWS account.
A structure containing the configuration information for the new healthcheck.
AmazonElasticBeanstalk exception
Constructs a new ValidationErrorException with the specified error
message.
Describes the error encountered.
ValidationMessage Unmarshaller
Response Unmarshaller for RestartAppServer operation
Rebuild Environment Request Marshaller
Response Unmarshaller for DescribeEnvironmentResources operation
Response Unmarshaller for DescribeConfigurationSettings operation
Response Unmarshaller for DeleteApplicationVersion operation
CreateStorageLocationResult Unmarshaller
Create Application Version Request Marshaller
Response Unmarshaller for CheckDNSAvailability operation
Describes the properties of an environment.
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EndpointURL property
The value to set for the EndpointURL property
this instance
Sets the CNAME property
The value to set for the CNAME property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the Health property
The value to set for the Health property
this instance
Sets the Resources property
The value to set for the Resources property
this instance
The name of this environment.
Constraints:
-
Length
4 - 23
The ID of this environment.
The name of the application associated with this environment.
Constraints:
-
Length
1 - 100
The application version deployed in this environment.
Constraints:
-
Length
1 - 100
The name of the SolutionStack deployed with this environment.
Constraints:
-
Length
0 - 100
The name of the configuration template used to originally launch this environment.
Constraints:
-
Length
1 - 100
Describes this environment.
Constraints:
-
Length
0 - 200
The URL to the LoadBalancer for this environment.
The URL to the CNAME for this environment.
Constraints:
-
Length
1 - 255
The creation date for this environment.
The last modified date for this environment.
The current operational status of the environment: - Launching: Environment is in the process of initial deployment.
- Updating: Environment is in the process of updating its configuration settings or application version.
- Ready:
Environment is available to have an action performed on it, such as update or terminate.
- Terminating: Environment is in
the shut-down process.
- Terminated: Environment is not running.
Constraints:
-
Allowed Values
Launching, Updating, Ready, Terminating, Terminated
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working. Yellow: Indicates that
something is wrong, the application might not be available, but the instances appear running. Green:
Indicates the environment is healthy and fully functional. - Red: Indicates the environment is not
responsive. Occurs when three or more consecutive failures occur for an environment.
- Yellow: Indicates that something is
wrong. Occurs when two consecutive failures occur for an environment.
- Green: Indicates the environment is healthy and
fully functional.
- Grey: Default health for a new environment. The environment is not fully launched and health checks have
not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default:
Grey
Constraints:
-
Allowed Values
Green, Yellow, Red, Grey
The description of the AWS resources used by this environment.
Container for the parameters to the SwapEnvironmentCNAMEs operation.
Sets the SourceEnvironmentId property
The value to set for the SourceEnvironmentId property
this instance
Sets the SourceEnvironmentName property
The value to set for the SourceEnvironmentName property
this instance
Sets the DestinationEnvironmentId property
The value to set for the DestinationEnvironmentId property
this instance
Sets the DestinationEnvironmentName property
The value to set for the DestinationEnvironmentName property
this instance
Returns information about the DescribeEnvironmentResourcesResult response and response metadata.
Gets and sets the DescribeEnvironmentResourcesResult property.
Result message containing a list of environment resource descriptions.
Subnet
Sets the SubnetId property
The subnet's ID
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the SubnetState property
The current state of the subnet (pending or
available).
this instance
Checks if SubnetState property is set
true if SubnetState property is set
Sets the VpcId property
The ID of the VPC the subnet is in
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the CidrBlock property
The CIDR block assigned to the subnet
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the AvailableIpAddressCount property
The number of unused IP addresses in the
subnet.
this instance
Checks if AvailableIpAddressCount property is set
true if AvailableIpAddressCount property is set
Sets the AvailabilityZone property
The Availability Zone the subnet is in.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Tag property
A list of tags for the Subnet.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the SubnetId property.
The subnet's ID
Gets and sets the SubnetState property.
The current state of the subnet (pending or
available).
Gets and sets the VpcId property.
The ID of the VPC the subnet is in
Gets and sets the CidrBlock property.
The CIDR block assigned to the subnet
Gets and sets the AvailableIpAddressCount property.
The number of unused IP addresses in the
subnet.
Gets and sets the AvailabilityZone property.
The Availability Zone the subnet is in.
Gets and sets the Tag property.
A list of tags for the Subnet.
Revokes permissions from a security group. The
permissions used to revoke
must be specified using the same values
used to grant the
permissions.
Permissions are specified by IP
protocol (TCP, UDP, or ICMP), the source of
the request (by IP
range or an Amazon EC2 user-group pair), the
source and destination
port ranges (for TCP and UDP), and the ICMP codes and
types (for ICMP).
Permission changes are quickly propagated to instances
within the security
group. However, depending on the number of
instances in the group, a
small delay is might occur.
Sets the UserId property
AWS Access Key ID.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the GroupName property
Name of the group to modify.
this instance
Checks if GroupName property is set
true if GroupName property is set
Sets the SourceSecurityGroupName property
Name of the security group. Cannot be used
when specifying a CIDR IP address.
this instance
Checks if SourceSecurityGroupName property is set
true if SourceSecurityGroupName property is set
Sets the SourceSecurityGroupOwnerId property
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
this instance
Checks if SourceSecurityGroupOwnerId property is set
true if SourceSecurityGroupOwnerId property is set
Sets the IpProtocol property
IP protocol. Valid Values: tcp | udp | icmp
this instance
Checks if IpProtocol property is set
true if IpProtocol property is set
Sets the FromPort property
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e.,
any ICMP type number).
this instance
Checks if FromPort property is set
true if FromPort property is set
Sets the ToPort property
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
this instance
Checks if ToPort property is set
true if ToPort property is set
Sets the CidrIp property
CIDR range.
this instance
Checks if CidrIp property is set
true if CidrIp property is set
Sets the IpPermissions property
Set of IP permissions associated with the
security group.
this instance
Checks if IpPermissions property is set
true if IpPermissions property is set
Gets and sets the UserId property.
AWS Access Key ID.
Gets and sets the GroupName property.
Name of the group to modify.
Gets and sets the SourceSecurityGroupName property.
Name of the security group. Cannot be used
when specifying a CIDR IP address.
Gets and sets the SourceSecurityGroupOwnerId property.
AWS User ID of an account. Cannot be used when
specifying a CIDR IP address.
Gets and sets the IpProtocol property.
IP protocol. Valid Values: tcp | udp | icmp
Gets and sets the FromPort property.
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e.,
any ICMP type number).
Gets and sets the ToPort property.
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
Gets and sets the CidrIp property.
CIDR range.
Gets and sets the IpPermissions property.
Set of IP permissions associated with the
security group.
Reset Image Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
ReplaceRouteTableAssociation Result
Checks if NewAssociationId property is set
true if NewAssociationId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the NewAssociationId property.
The ID representing the new association.
Registers an AMI with Amazon EC2. Images must be
registered before they
can be launched. To launch instances, use
the RunInstances operation.
Each AMI is associated with an unique
ID which is provided by the Amazon
EC2 service through the
RegisterImage operation. During registration,
Amazon EC2 retrieves
the specified image manifest from Amazon S3
and verifies that the
image is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon
EC2. Any modifications to an image in Amazon S3 invalidates this
registration. If you make changes to an image, deregister the
previous image and register
the new image. To deregister an image,
use the DeregisterImage
operation.
Sets the ImageLocation property
Full path to your AMI manifest in Amazon S3
storage.
this instance
Checks if ImageLocation property is set
true if ImageLocation property is set
Sets the Name property
The name of the AMI that was provided during
image creation.
this instance
Checks if Name property is set
true if Name property is set
Sets the Description property
The description of the AMI. Must be 3-128
alphanumeric characters,
parenthesis (()), commas (,), slashes
(/), dashes (-), or
underscores(_).
this instance
Checks if Description property is set
true if Description property is set
Sets the Architecture property
Architecture property
this instance
Checks if Architecture property is set
true if Architecture property is set
Sets the KernelId property
The ID of the kernel to select.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
The ID of the RAM disk to select. Some kernels
require additional drivers at launch. Check the kernel
requirements for information on whether you need to
specify a
RAM disk.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the RootDeviceName property
The root device name (e.g., /dev/sda1).
this instance
Checks if RootDeviceName property is set
true if RootDeviceName property is set
Sets the BlockDeviceMapping property
BlockDeviceMapping property
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Gets and sets the ImageLocation property.
Full path to your AMI manifest in Amazon S3
storage.
Gets and sets the Name property.
The name of the AMI that was provided during
image creation.
Gets and sets the Description property.
The description of the AMI. Must be 3-128
alphanumeric characters,
parenthesis (()), commas (,), slashes
(/), dashes (-), or
underscores(_).
Gets and sets the Architecture property.
Gets and sets the KernelId property.
The ID of the kernel to select.
Gets and sets the RamdiskId property.
The ID of the RAM disk to select. Some kernels
require additional drivers at launch. Check the kernel
requirements for information on whether you need to
specify a
RAM disk.
Gets and sets the RootDeviceName property.
The root device name (e.g., /dev/sda1).
Gets and sets the BlockDeviceMapping property.
Reboot Instances Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Key Pair
Sets the KeyName property
The key pair name provided in the original
request.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the KeyFingerprint property
A SHA-1 digest of the DER encoded private key.
this instance
Checks if KeyFingerprint property is set
true if KeyFingerprint property is set
Sets the KeyMaterial property
Only returned on create
this instance
Checks if KeyMaterial property is set
true if KeyMaterial property is set
Gets and sets the KeyName property.
The key pair name provided in the original
request.
Gets and sets the KeyFingerprint property.
A SHA-1 digest of the DER encoded private key.
Gets and sets the KeyMaterial property.
Only returned on create
IP Permission
Sets the IpProtocol property
IP protocol.Valid Values: tcp | udp | icmp
this instance
Checks if IpProtocol property is set
true if IpProtocol property is set
Sets the FromPort property
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e., any ICMP type
number).
this instance
Checks if FromPort property is set
true if FromPort property is set
Sets the ToPort property
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
this instance
Checks if ToPort property is set
true if ToPort property is set
Sets the UserIdGroupPair property
List of security group and user ID pairs.
this instance
Checks if UserIdGroupPair property is set
true if UserIdGroupPair property is set
Sets the IpRange property
IP ranges.
this instance
Checks if IpRange property is set
true if IpRange property is set
Gets and sets the IpProtocol property.
IP protocol.Valid Values: tcp | udp | icmp
Gets and sets the FromPort property.
Start of port range for the TCP and UDP
protocols, or an ICMP type
number. An ICMP type number of -1
indicates a wildcard (i.e., any ICMP type
number).
Gets and sets the ToPort property.
End of port range for the TCP and UDP
protocols, or an ICMP code.
An ICMP code of -1 indicates a
wildcard (i.e., any ICMP code).
Gets and sets the UserIdGroupPair property.
List of security group and user ID pairs.
Gets and sets the IpRange property.
IP ranges.
AMI
Sets the ImageId property
The ID of the AMI.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the ImageLocation property
The location of the AMI.
this instance
Checks if ImageLocation property is set
true if ImageLocation property is set
Sets the ImageState property
Current state of the AMI. If the operation
return
this instance
Checks if ImageState property is set
true if ImageState property is set
Sets the OwnerId property
AWS Access Key ID of the image owner.
this instance
Checks if OwnerId property is set
true if OwnerId property is set
Sets the Visibility property
Visibility - public or private
this instance
Checks if Visibility property is set
true if Visibility property is set
Sets the ProductCode property
Product codes of the AMI
this instance
Checks if ProductCode property is set
true if ProductCode property is set
Sets the Architecture property
The architecture of the image.
this instance
Checks if Architecture property is set
true if Architecture property is set
Sets the ImageType property
The type of image
this instance
Checks if ImageType property is set
true if ImageType property is set
Sets the KernelId property
The kernel associated with the image, if any.
Only applicable for machine images.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
The RAM disk associated with the image, if any.
Only applicable for machine images.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the Platform property
The operating platform of the instance.
this instance
Checks if Platform property is set
true if Platform property is set
Sets the StateReason property
The reason for the state change.
this instance
Checks if StateReason property is set
true if StateReason property is set
Sets the ImageOwnerAlias property
The AWS account alias (e.g., "amazon") or AWS
account ID that owns the AMI.
this instance
Checks if ImageOwnerAlias property is set
true if ImageOwnerAlias property is set
Sets the Name property
The name of the AMI.
this instance
Checks if Name property is set
true if Name property is set
Sets the Description property
The description of the AMI.
this instance
Checks if Description property is set
true if Description property is set
Sets the RootDeviceType property
The root device type used by the AMI. The AMI
can use an Amazon EBS or instance store root device.
this instance
Checks if RootDeviceType property is set
true if RootDeviceType property is set
Sets the RootDeviceName property
The root device name (e.g., /dev/sda1).
this instance
Checks if RootDeviceName property is set
true if RootDeviceName property is set
Sets the BlockDeviceMapping property
Specifies how block devices are exposed to the
instance.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Sets the VirtualizationType property
Specifies whether the Amazon EC2 instance is a
hardware virtual machine
(HVM) or a para-virtual machine (PVM).
this instance
Checks if VirtualizationType property is set
true if VirtualizationType property is set
Sets the Tag property
A list of tags for the Image.
this instance
Checks if Tag property is set
true if Tag property is set
Sets the Hypervisor property
Hypervisor property
this instance
Checks if Hypervisor property is set
true if Hypervisor property is set
Gets and sets the ImageId property.
The ID of the AMI.
Gets and sets the ImageLocation property.
The location of the AMI.
Gets and sets the ImageState property.
Current state of the AMI. If the operation
return
Gets and sets the OwnerId property.
AWS Access Key ID of the image owner.
Gets and sets the Visibility property.
Visibility - public or private
Gets and sets the ProductCode property.
Product codes of the AMI
Gets and sets the Architecture property.
The architecture of the image.
Gets and sets the ImageType property.
The type of image
Gets and sets the KernelId property.
The kernel associated with the image, if any.
Only applicable for machine images.
Gets and sets the RamdiskId property.
The RAM disk associated with the image, if any.
Only applicable for machine images.
Gets and sets the Platform property.
The operating platform of the instance.
Gets and sets the StateReason property.
The reason for the state change.
Gets and sets the ImageOwnerAlias property.
The AWS account alias (e.g., "amazon") or AWS
account ID that owns the AMI.
Gets and sets the Name property.
The name of the AMI.
Gets and sets the Description property.
The description of the AMI.
Gets and sets the RootDeviceType property.
The root device type used by the AMI. The AMI
can use an Amazon EBS or instance store root device.
Gets and sets the RootDeviceName property.
The root device name (e.g., /dev/sda1).
Gets and sets the BlockDeviceMapping property.
Specifies how block devices are exposed to the
instance.
Gets and sets the VirtualizationType property.
Specifies whether the Amazon EC2 instance is a
hardware virtual machine
(HVM) or a para-virtual machine (PVM).
Gets and sets the Tag property.
A list of tags for the Image.
Gets and sets the Hypervisor property.
Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead it uses the
routes in the VPC's main route table. For more information about route tables, go to Route Tables in the
Amazon Virtual Private Cloud User Guide.
Sets the AssociationId property
The association ID representing the current
association between the route table and
subnet.
this instance
Checks if AssociationId property is set
true if AssociationId property is set
Gets and sets the AssociationId property.
The association ID representing the current
association between the route table and
subnet.
Disassociates the specified elastic IP address
from the instance to which it is
assigned. This is an idempotent
operation. If you enter it more
than once, Amazon EC2 does not
return an error.
Sets the PublicIp property
IP address that you are disassociating from
the instance.
this instance
Checks if PublicIp property is set
true if PublicIp property is set
Sets the AssociationId property
Association ID corresponding to the VPC elastic IP address
you want to disassociate.
Condition: Required for VPC elastic IP addresses
this instance
Checks if AssociationId property is set
true if AssociationId property is set
Gets and sets the PublicIp property.
IP address that you are disassociating from
the instance.
Gets and sets the AssociationId property.
Association ID corresponding to the VPC elastic IP address
you want to disassociate.
Condition: Required for VPC elastic IP addresses
DescribeTags Result
Checks if ResourceTag property is set
true if ResourceTag property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResourceTag property.
A list of tags for the specified resources.
Describe Spot Datafeed Result
Checks if SpotDatafeedSubscription property is set
true if SpotDatafeedSubscription property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SpotDatafeedSubscription property.
The description of the Spot Datafeed
subsciption.
Gives you information about your Internet gateways.You can filter the results to return information only
about Internet gateways that match criteria you specify. For example, you could get information only
about gateways with particular tags. The Internet gateway must match at least one of the specified values
for it to be included in the results.
You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged
with a particular value). The result includes information for a particular Internet gateway only if the gateway
matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly
one character.You can escape special characters using a backslash before the character. For example,
a value of \*amazon\?\\ searches for the literal string *amazon?\.
Sets the InternetGatewayId property
IDs of the Internet gateway.
this instance
Checks if InternetGatewayId property is set
true if InternetGatewayId property is set
Sets the Filter property
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the InternetGatewayId property.
IDs of the Internet gateway.
Gets and sets the Filter property.
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Image Attribute Result
Checks if ImageAttribute property is set
true if ImageAttribute property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ImageAttribute property.
Image Attribute
Describe Customer Gateways Result
Checks if CustomerGateway property is set
true if CustomerGateway property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CustomerGateway property.
List of customer gateways
Describe Availability Zones Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeAvailabilityZonesResult property is set
true if DescribeAvailabilityZonesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeAvailabilityZonesResult property.
Describe Availability Zones Result
The Response for the
DeleteRoute operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Vpn Connection Result
Checks if VpnConnection property is set
true if VpnConnection property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the VpnConnection property.
Vpn connection
Create Vpc Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateVpcResult property is set
true if CreateVpcResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateVpcResult property.
Create Vpc Result
Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you then attach
it to a VPC using AttachInternetGateway. For more information about your VPC and Internet gateway,
go to Amazon Virtual Private Cloud User Guide.
Console Output
Sets the InstanceId property
The instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Timestamp property
The time the output was last updated.
this instance
Checks if Timestamp property is set
true if Timestamp property is set
Sets the Output property
The console output, Base64 encoded.
this instance
Checks if Output property is set
true if Output property is set
Gets and sets the InstanceId property.
The instance ID.
Gets and sets the Timestamp property.
The time the output was last updated.
Gets and sets the Output property.
The console output, Base64 encoded.
Associates an elastic IP address with an instance. If the IP address is
currently assigned to another instance, the IP address is assigned
to the new instance. This is an idempotent operation. If you enter it more than once,
Amazon EC2 does not return an error.
Sets the InstanceId property
The instance to associate with the IP address.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the PublicIp property
IP address that you are assigning to the
instance.
this instance
Checks if PublicIp property is set
true if PublicIp property is set
Sets the AllocationId property
The allocation ID that AWS returned when you allocated
the elastic IP address for use with Amazon VPC.
Condition: Required for VPC elastic IP addresses
this instance
Checks if AllocationId property is set
true if AllocationId property is set
Gets and sets the InstanceId property.
The instance to associate with the IP address.
Gets and sets the PublicIp property.
IP address that you are assigning to the
instance.
Gets and sets the AllocationId property.
The allocation ID that AWS returned when you allocated
the elastic IP address for use with Amazon VPC.
Condition: Required for VPC elastic IP addresses
Response Unmarshaller for GetMetricStatistics operation
Describe Alarms For Metric Request Marshaller
AmazonCloudWatch exception
Constructs a new MissingRequiredParameterException with the specified error
message.
Describes the error encountered.
The MetricDatum data type encapsulates the information
sent with PutMetricData to either create a new metric or add new
values to be aggregated into an existing metric.
Sets the MetricName property
The value to set for the MetricName property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the Value property
The value to set for the Value property
this instance
Sets the StatisticValues property
The value to set for the StatisticValues property
this instance
Sets the Unit property
The value to set for the Unit property
this instance
The name of the metric.
Constraints:
-
Length
1 - 255
A list of dimensions associated with the metric.
Constraints:
-
Length
0 - 10
The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.
The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates
values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10
exponents less than -130 (1 x 10^-130) are also truncated.
A set of statistical values describing the metric.
The unit of the metric.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
Container for the parameters to the EnableAlarmActions operation.
Enables actions for the specified alarms.
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
The names of the alarms to enable actions for.
Constraints:
-
Length
0 - 100
The SetStreamingDistributionConfigRequest contains the parameters used for the
SetStreamingDistributionConfig operation.
The ETag parameter is used if you wish to specify the ETag to match with the
ETag of the StreamingDistribution with the Id specified.
Required Parameters: Id
Required Parameters: StreamingDistributionConfig
Required Parameters: ETag of the Streaming Distribution. This value can
be retrieved via a call to GetStreamingDistributionInfo.
If you want to serve private content, you need to:
- Associate an Origin Access Identity with the StreamingDistributionConfig
- Associate TrustedSigners with the StreamingDistributionConfig if you want to
serve content via Signed URLs
Sets the Id property for this request.
This is the CloudFront Streaming Distribution Id that will be reconfigured
by this request.
The value that Id is set to
the request with the Id set
Sets the StreamingDistributionConfig property for this request.
The value that StreamingDistributionConfig is set to
the request with the Configuration set
Sets the ETag property for this request.
This is the ETag of the CloudFront Streaming Distribution which
will be reconfigured.
The value that ETag is set to
the request with the ETag set
Gets and sets the Id property.
Gets and Sets the StreamingDistributionConfig property.
The CloudFront Streaming Distribution's configuration will
be modified to reflect the values in this configuration object.
Gets and sets the ETag property. This should be the ETag of the
Streaming Distribution.
The origin protocol policy to apply to your origin. If HttpOnly is specified,
CloudFront will use HTTP only to
access the origin. If MatchViewer is specified,
CloudFront will fetch from your origin using HTTP or
HTTPS, based on the protocol of the viewer request.
Custom origin information to associate with the distribution.
Initializes a new instance of the CustomOrigin class.
Initializes a new instance of the CustomOrigin class.
The DNS name of your Amazon S3 bucket.
Sets the origin to associate with the distribution.
For example: www.example.com.
This instance is returned to allow method chaining.
The DNSName for the origin.
This instance
Sets the HTTP port.
This instance is returned to allow method chaining.
The HTTP port.
This instance
Sets the HTTPS port.
This instance is returned to allow method chaining.
The HTTPS port.
This instance
Sets the origin protocol policy to apply to your origin. If HttpOnly is specified,
CloudFront will use HTTP only to
access the origin. If MatchViewer is specified,
CloudFront will fetch from your origin using HTTP or
HTTPS, based on the protocol of the viewer request.
This instance is returned to allow method chaining.
The origin protocol policy.
This instance
Gets or sets the origin to associate with the distribution.
For example: www.example.com.
The DNSName for the origin.
Gets or sets the HTTP port.
The HTTP port.
Gets or sets the HTTPS port.
The HTTPS port.
Gets or sets the origin protocol policy to apply to your origin. If HttpOnly is specified,
CloudFront will use HTTP only to
access the origin. If MatchViewer is specified,
CloudFront will fetch from your origin using HTTP or
HTTPS, based on the protocol of the viewer request.
The origin protocol policy.
Response Unmarshaller for ValidateTemplate operation
ListStackResourcesResult Unmarshaller
AmazonCloudFormation exception
Constructs a new LimitExceededException with the specified error
message.
Describes the error encountered.
Returns information about the CreateStackResult response and response metadata.
Gets and sets the CreateStackResult property.
The output for a CreateStack action.
Response Unmarshaller for SuspendProcesses operation
ProcessType Unmarshaller
Ebs Unmarshaller
DescribeAutoScalingNotificationTypesResult Unmarshaller
DescribeAutoScalingGroupsResult Unmarshaller
Response Unmarshaller for DescribeAutoScalingGroups operation
DescribeAdjustmentTypesResult Unmarshaller
AdjustmentType Unmarshaller
The output for the TerminateInstanceInAutoScalingGroup action.
Sets the Activity property
The value to set for the Activity property
this instance
A Scaling Activity.
Returns information about the SuspendProcesses response metadata.
The SuspendProcesses operation has a void result type.
An Auto Scaling process that has been suspended. For more information, see ProcessType.
Sets the ProcessName property
The value to set for the ProcessName property
this instance
Sets the SuspensionReason property
The value to set for the SuspensionReason property
this instance
The name of the suspended process.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The reason that the process was suspended.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns information about the ResumeProcesses response metadata.
The ResumeProcesses operation has a void result type.
Container for the parameters to the DescribeAutoScalingInstances operation.
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full
details of all instances up to a maximum of fifty. This action supports pagination by returning a token if there are more
pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
Adds elements to the InstanceIds collection
The values to add to the InstanceIds collection
this instance
Adds elements to the InstanceIds collection
The values to add to the InstanceIds collection
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested
instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.
The maximum number of Auto Scaling instances to be described with each call.
Constraints:
-
Range
1 - 50
The token returned by a previous call to indicate that there is more data available.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns information about the DescribeAdjustmentTypesResult response and response metadata.
Gets and sets the DescribeAdjustmentTypesResult property.
The output of the DescribeAdjustmentTypes action.
Container for the parameters to the DeletePolicy operation.
Deletes a policy created by PutScalingPolicy
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name or PolicyARN of the policy you want to delete
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The AutoScalingGroup data type.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the AutoScalingGroupARN property
The value to set for the AutoScalingGroupARN property
this instance
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Sets the MinSize property
The value to set for the MinSize property
this instance
Sets the MaxSize property
The value to set for the MaxSize property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
Sets the DefaultCooldown property
The value to set for the DefaultCooldown property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
Sets the HealthCheckType property
The value to set for the HealthCheckType property
this instance
Sets the HealthCheckGracePeriod property
The value to set for the HealthCheckGracePeriod property
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Sets the CreatedTime property
The value to set for the CreatedTime property
this instance
Adds elements to the SuspendedProcesses collection
The values to add to the SuspendedProcesses collection
this instance
Adds elements to the SuspendedProcesses collection
The values to add to the SuspendedProcesses collection
this instance
Sets the PlacementGroup property
The value to set for the PlacementGroup property
this instance
Sets the VPCZoneIdentifier property
The value to set for the VPCZoneIdentifier property
this instance
Adds elements to the EnabledMetrics collection
The values to add to the EnabledMetrics collection
this instance
Adds elements to the EnabledMetrics collection
The values to add to the EnabledMetrics collection
this instance
Specifies the name of the group.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Specifies the name of the associated LaunchConfiguration.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Contains the minimum size of the AutoScalingGroup.
Contains the maximum size of the AutoScalingGroup.
Specifies the desired capacity for the AutoScalingGroup.
The number of seconds after a scaling activity completes before any further scaling activities can start.
Contains a list of availability zones for the group.
Constraints:
-
Length
1 -
A list of load balancers associated with this Auto Scaling group.
The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into
service.
Provides a summary list of EC2 instances.
Specifies the date and time the Auto Scaling group was created.
Suspended processes associated with this Auto Scaling group.
The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2
User Guide.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The identifier for the VPC connection, if applicable.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
A list of metrics enabled for this Auto Scaling group.
A statement is the formal description of a single permission, and is always
contained within a policy object.
A statement describes a rule for allowing or denying access to a specific AWS
resource based on how the resource is being accessed, and who is attempting
to access the resource. Statements can also optionally contain a list of
conditions that specify when a statement is to be honored.
For example, consider a statement that:
-
A is the prinicpal
The AWS account that is making a request to
access or modify one of your AWS resources.
-
B is the action
the way in which your AWS resource is being accessed or modified, such
as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket.
-
C is the resource
your AWS entity that the principal wants to access, such
as an Amazon SQS queue, or an object stored in Amazon S3.
-
D is the set of conditions
optional constraints that specify when to allow or deny
access for the principal to access your resource. Many expressive conditions are available,
some specific to each service. For example you can use date conditions to allow access to
your resources only after or before a specific time.
There are many resources and conditions available for use in statements, and
you can combine them to form fine grained custom access control polices.
Constructs a new access control policy statement with the specified
effect.
Before a statement is valid and can be sent to AWS, callers must set the
principals, resources, and actions (as well as any optional conditions)
involved in the statement.
The effect this statement has (allowing access or denying
access) when all conditions, resources, principals, and
actions are matched.
Sets the ID for this statement and returns the updated statement so
multiple calls can be chained together.
Statement IDs serve to help keep track of multiple statements, and are
often used to give the statement a meaningful, human readable name.
Developers should be careful to not use the same statement ID for
multiple statements in the same policy. Reusing the same statement ID in
different policies is not a problem.
The new statement ID for this statement.
this instance
Sets the list of actions to which this policy statement applies and
returns this updated Statement object so that additional method calls can
be chained together.
Actions limit a policy statement to specific service operations that are
being allowed or denied by the policy statement. For example, you might
want to allow any AWS user to post messages to your SQS queue using the
SendMessage action, but you don't want to allow those users other actions
such as ReceiveMessage or DeleteQueue.
The list of actions to which this statement applies.
this instance
Sets the resources associated with this policy statement and returns this
updated Statement object so that additional method calls can be chained
together.
Resources are what a policy statement is allowing or denying access to,
such as an Amazon SQS queue or an Amazon SNS topic.
Note that some services allow only one resource to be specified per
policy statement.
The resources associated with this policy statement.
this instance
Sets the conditions associated with this policy statement, and returns
this updated Statement object so that additional method calls can be
chained together.
Conditions allow policy statements to be conditionally evaluated based on
the many available condition types.
For example, a statement that allows access to an Amazon SQS queue could
use a condition to only apply the effect of that statement for requests
that are made before a certain date, or that originate from a range of IP
addresses.
Multiple conditions can be included in a single statement, and all
conditions must evaluate to true in order for the statement to take
effect.
The conditions associated with this policy statement.
this instance
Sets the principals associated with this policy statement, and returns
this updated Statement object. Principals control which AWS accounts are
affected by this policy statement.
If you don't want to restrict your policy to specific users, you can use
to apply the policy to any user trying to
access your resource.
The list of principals associated with this policy statement.
this instance
Gets and Sets the ID for this statement. Statement IDs serve to help keep track
of multiple statements, and are often used to give the statement a
meaningful, human readable name.
Developers should be careful to not use the same statement ID for
multiple statements in the same policy. Reusing the same statement ID in
different policies is not a problem.
Gets and Sets the result effect of this policy statement when it is evaluated.
A policy statement can either allow access or explicitly
Gets and Sets the list of actions to which this policy statement applies.
Actions limit a policy statement to specific service operations that are
being allowed or denied by the policy statement. For example, you might
want to allow any AWS user to post messages to your SQS queue using the
SendMessage action, but you don't want to allow those users other actions
such as ReceiveMessage or DeleteQueue.
Gets and Sets the resources associated with this policy statement. Resources
are what a policy statement is allowing or denying access to, such as an
Amazon SQS queue or an Amazon SNS topic.
Note that some services allow only one resource to be specified per
policy statement.
Gets and Sets the conditions associated with this policy statement. Conditions
allow policy statements to be conditionally evaluated based on the many
available condition types.
For example, a statement that allows access to an Amazon SQS queue could
use a condition to only apply the effect of that statement for requests
that are made before a certain date, or that originate from a range of IP
addresses.
When multiple conditions are included in a single statement, all
conditions must evaluate to true in order for the statement to take
effect.
Gets and Sets the principals associated with this policy statement, indicating
which AWS accounts are affected by this policy statement.
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.
A factory for creating resources to be used in the policy.
Constructs a new bucket resource that represents the the specified bucket
but not any of the contained objects.
The name of the bucket represented by this AWS access control
policy resource.
Constructs a new object resource that represents the specified objects.
The keyPattern argument may contain the '*' wildcard to match multiple
objects. For example, an object resource created for bucket 'mybucket'
and key pattern 'foo*' will match any object stored in 'mybucket' with a
key that starts with 'foo'.
The name of the bucket containing the object or objects
represented by this resource.
The key or key pattern, which can optionally contain the '*'
wildcard to include multiple objects in the resource.
Constructs a new SQS queue resource for an access control policy. A
policy statement using this resource will allow or deny actions on the
specified queue.
The AWS account ID of the queue owner.
The name of the Amazon SQS queue.
AWS access control policy conditions are contained in
objects, and affect when a statement is applied. For example, a statement
that allows access to an Amazon SQS queue could use a condition to only apply
the effect of that statement for requests that are made before a certain
date, or that originate from a range of IP addresses.
Multiple conditions can be included in a single statement, and all conditions
must evaluate to true in order for the statement to take effect.
The set of conditions is D in the statement
"A has permission to do B to C where D applies."
A condition is composed of three parts:
-
Condition Key
The condition key declares which value of a
request to pull in and compare against when a policy is evaluated by AWS. For
example, using will cause
AWS to pull in the current request's source IP as the first value to compare
against every time your policy is evaluated.
-
Comparison Type
This is a static value used as the second value
in the comparison when your policy is evaluated. Depending on the comparison
type, this value can optionally use wildcards. See the documentation for
individual comparison types for more information.
-
Comparison Value
This is a static value used as the second value
in the comparison when your policy is evaluated. Depending on the comparison
type, this value can optionally use wildcards. See the documentation for
individual comparison types for more information.
Gets the type of this condition.
Gets and Sets the name of the condition key involved in this condition.
Condition keys are predefined values supported by AWS that provide input
to a condition's evaluation, such as the current time, or the IP address
of the incoming request.
Your policy is evaluated for each incoming request, and condition keys
specify what information to pull out of those incoming requests and plug
into the conditions in your policy.
Gets and Sets the values specified for this access control policy condition.
For example, in a condition that compares the incoming IP address of a
request to a specified range of IP addresses, the range of IP addresses
is the single value in the condition.
Most conditions accept only one value, but multiple values are possible.
Serializes an AWS policy object to a JSON string, suitable for sending to an
AWS service.
Converts the specified AWS policy object to a JSON string, suitable for
passing to an AWS service.
@param policy
The AWS policy object to convert to a JSON string.
@return The JSON string representation of the specified policy object.
@throws IllegalArgumentException
If the specified policy is null or invalid and cannot be
serialized to a JSON string.
Uses the specified generator to write the JSON data for the principals in
the specified policy statement.
This sorts the conditions by condition type and key with the list of values for that combination.
The list of conditions to be sorted.
Deserializes a JSON string into a AWS policy object.
he ListQueues action returns a list of your queues. The maximum number of queues that can be returned is 1000.
If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the
specified value are returned.
Sets the QueueNamePrefix property
String to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
this instance
Checks if QueueNamePrefix property is set
true if QueueNamePrefix property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueNamePrefix property.
String to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
Encapsulates the metadata and result of the SetTopicAttributes action.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
Encapsulates the result of the Publish action.
Checks if MessageId property is set
true if MessageId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the MessageId property.
Unique identifier assigned to the published message.
Encapsulates the result of the ListSubscriptionsByTopic action.
Checks if Subscriptions property is set
true if Subscriptions property is set
Checks if NextToken property is set
true if NextToken property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Subscriptions property.
A list of subscriptions.
Gets and sets the NextToken property.
Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
Encapsulates the result of the GetTopicAttributes action.
Checks if Attributes property is set
true if Attributes property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Attributes property.
A map of the topic's attributes. Attributes in this map include the following:
- TopicArn -- the topic's ARN
- Owner -- the AWS account ID of the topic's owner
- Policy -- the JSON serialization of the topic's access control policy
- DisplayName -- the human-readable name used in the "From" field for notifications
to email and email-json endpoints
Error associated with the request.
Sets the Type property
The error type. There are two types of error codes: client and server.
these error codes are prefixed with Client. For example: Client.AuthFailure.
this instance
Checks if Type property is set
true if Type property is set
Sets the Code property
The specific error code. See the Load Balancing developer documentation for more details.
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
A summary of the error.
this instance
Checks if Message property is set
true if Message property is set
Sets the Detail property
Details associated with the error.
this instance
Checks if Detail property is set
true if Detail property is set
Gets and sets the Type property.
The error type. There are two types of error codes: client and server.
these error codes are prefixed with Client. For example: Client.AuthFailure.
Gets and sets the Code property.
The specific error code. See the Load Balancing developer documentation for more details.
Gets and sets the Message property.
A summary of the error.
Gets and sets the Detail property.
Details associated with the error.
The CreateTopic action creates a topic to which notifications can be published. Users can create
at most 25 topics. This action is idempotent, so if the requester
already owns a topic with the specified name, that topic's ARN will be
returned without creating a new topic.
Sets the Name property
Name property
this instance
Checks if Name property is set
true if Name property is set
Gets and sets the Name property.
Represents the raw data of the message.
Default constructor for a new RawMessage object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new RawMessage object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The raw data of the message. The client must ensure that the message format complies with Internet email standards
regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary). For more information, go to the Amazon SES Developer Guide.
Sets the Data property
The value to set for the Data property
this instance
The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header
fields, MIME types, MIME encoding, and base64 encoding (if necessary). For more information, go to the Amazon SES Developer Guide.
A list of errors associated with a request returned by Amazon SimpleDB.
Sets the Error property
A specific error associated with a Amazon SimpleDB request.
this instance
Checks if Error property is set
true if Error property is set
Sets the RequestId property
A unique ID for tracking the request.
this instance
Checks if RequestId property is set
true if RequestId property is set
XML Representation for this object
XML String
Gets and sets the Error property.
A specific error associated with a Amazon SimpleDB request.
Gets and sets the RequestId property.
A unique ID for tracking the request.
Returns information about the domain, including when the domain was created, the number of items and
attributes, and the size of attribute names and values.
Sets the DomainMetadataResult property
Returns information about the domain, including when the domain was created, the number of items and
attributes, and the size of attribute names and values.
this instance
Checks if DomainMetadataResult property is set
true if DomainMetadataResult property is set
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the DomainMetadataResult property.
Returns information about the domain, including when the domain was created, the number of items and
attributes, and the size of attribute names and values.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
The SetNotificationConfigurationRequest contains the parameters used for the SetNotificationConfiguration operation.
If the NotificationConfiguration is null or empty then the current configuration will be cleared.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket the request will get the location for.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the NotificationConfiguration property for this request.
The value that NotificationConfiguration is set to
this instance
Gets and sets the BucketName property.
Gets and sets the NotificationConfiguration property.
The DisableBucketLoggingRequest contains the parameters used for the DisableBucketLogging operation.
Required Parameters: BucketName
BucketLoggingConfig represents a configuration for the S3 bucket
logging operatons. This includes a target bucket name which is where
the logs will be stored, a target prefix which is the prefix assigned
to all log files, and a List of grants which will set the AccessControl
for the logs.
Creates a S3Grant and adds it to the list of grants.
The grantee for the grant.
The permission for the grantee.
Removes a specific permission for the given grantee.
The grantee
The permission for the grantee to remove
Removes all permissions for the given grantee.
Creates an XML representation of this logging configuration which
is to be sent to S3 when setting up bucket logging.
XML representation of the logging configuration
Sets the Grants property.
Grants property
this instance
Checks if Grants property is set.
true if Grants property is set.
Sets the TargetBucketName property.
TargetBucketName property
this instance
Checks if TargetBucketName property is set.
true if TargetBucketName property is set.
Sets the TargetPrefix property.
If no value is set for the property, the default value
for the TargetPrefix is the empty string
TargetPrefix property
this instance
Checks if TargetPrefix property is set to a non-null value.
true if TargetPrefix property is set.
Gets and sets the Grants property.
Gets and sets the TargetBucketName property.
Gets and sets the TargetPrefix property.
The default value for the TargetPrefix is the empty string
The PutBucketWebsiteResponse contains any headers returned by S3.
The PutBucketPolicyResponse contains any headers returned by S3.
The CompleteMultipartUploadRequest contains the parameters used for the CompleteMultipartUpload method.
Required Parameters: BucketName, Key, UploadId, PartETags
Sets the BucketName property for this request.
This is the S3 Bucket where the S3 Object you are
creating gets put.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you create.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the UploadId property for this request.
This is the upload id for the multipart upload in process.
The value that Key is set to
the request with the Key set
Checks if UploadId property is set.
true if UploadId property is set.
Adds the elements from the array in the collection of PartETags for this request.
PartETags that will added to this request.
the request with the PartETags set
Adds the elements from the array in the collection of PartETags for this request.
PartETags that will added to this request.
The request with the PartETags set
Transforms the UploadPartResponses into PartETags and adds them to the request.
The list of response objects return from UploadParts.
The request with the PartETags set.
Transforms the UploadPartResponses into PartETags and adds them to the request.
The list of response objects return from UploadParts.
The request with the PartETags set
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the UploadId property.
This is the upload id for the multipart upload in process.
Gets and sets the PartETags property. This collection contains an entry for every part uploaded
with its part number and etag.
Result Unmarshaller for DescribeEngineDefaultParameters operation
Response Unmarshaller for DescribeDBInstances operation
Response Unmarshaller for CreateDBParameterGroup operation
AmazonRDS exception
Constructs a new ReservedDBInstancesOfferingNotFoundException with the specified error
message.
Describes the error encountered.
This data type is used as a response element in the ModifyDBInstance action.
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the AllocatedStorage property
The value to set for the AllocatedStorage property
this instance
Sets the MasterUserPassword property
The value to set for the MasterUserPassword property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the BackupRetentionPeriod property
The value to set for the BackupRetentionPeriod property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.
Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB Instance.
Specifies the pending port for the DB Instance.
Specifies the pending number of days for which automated backups are retained.
Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.
Indicates the database engine version.
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
The name of the DB Parameter Group.
AmazonRDS exception
Constructs a new InsufficientDBInstanceCapacityException with the specified error
message.
Describes the error encountered.
AmazonRDS exception
Constructs a new DBSecurityGroupAlreadyExistsException with the specified error
message.
Describes the error encountered.
AmazonRDS exception
Constructs a new DBInstanceAlreadyExistsException with the specified error
message.
Describes the error encountered.
Returns information about the CreateDBSecurityGroup response and response metadata.
Gets and sets the CreateDBSecurityGroupResult property.
Contains the result of a successful invocation of the CreateDBSecurityGroup
action.
Returns information about the CreateDBInstance response and response metadata.
Gets and sets the CreateDBInstanceResult property.
Contains the result of a successful invocation of the CreateDBInstance
action.
Representation of a job returned by the ListJobs operation.
Sets the JobId property
The value to set for the JobId property
this instance
Sets the CreationDate property
The value to set for the CreationDate property
this instance
Sets the IsCanceled property
The value to set for the IsCanceled property
this instance
Sets the JobType property
The value to set for the JobType property
this instance
A unique identifier which refers to a particular job.
Timestamp of the CreateJob request in ISO8601 date format. For example
"2010-03-28T20:27:35Z".
Indicates whether the job was canceled.
Specifies whether the job to initiate is an import or export job.
Constraints:
-
Allowed Values
Import, Export
AmazonImportExport exception
Constructs a new InvalidAccessKeyIdException with the specified error
message.
Describes the error encountered.
Returns information about the CancelJobResult response and response metadata.
Gets and sets the CancelJobResult property.
Output structure for the CancelJob operation.
Returns information about the UpdateGroup response metadata.
The UpdateGroup operation has a void result type.
Container for the parameters to the UpdateGroup operation.
Updates the name and/or the path of the specified group.
IMPORTANT: You should understand the implications of
changing a group's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a group name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Managers to MGRs, the entity making
the request must have permission on Managers and MGRs, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the NewPath property
The value to set for the NewPath property
this instance
Sets the NewGroupName property
The value to set for the NewGroupName property
this instance
Name of the group to update. If you're changing the name of the group, this is the original name.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
New path for the group. Only include this if changing the group's path.
Constraints:
-
Length
1 - 512
-
Pattern
(\u002F)|(\u002F[\u0021-\u007F]+\u002F)
New name for the group. Only include this if changing the group's name.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
User Unmarshaller
Update Access Key Request Marshaller
Put Group Policy Request Marshaller
Response Unmarshaller for ListUsers operation
Response Unmarshaller for GetUserPolicy operation
Response Unmarshaller for DeactivateMFADevice operation
CreateGroupResult Unmarshaller
AmazonIdentityManagementService exception
Constructs a new MalformedCertificateException with the specified error
message.
Describes the error encountered.
Container for the parameters to the ListMFADevices operation.
Lists the MFA devices associated with the specified User
name. You can paginate the results using the
MaxItems and Marker parameters.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
Name of the User whose MFA devices you want to list.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of keys you want in the response. If there are additional keys beyond
the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Contains the result of a successful invocation of the
ListGroupPolicies action.
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Adds elements to the PolicyNames collection
The values to add to the PolicyNames collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of policy names.
A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination
request using the Marker request parameter to retrieve more policy names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Container for the parameters to the ListGroupPolicies operation.
Lists the names of the policies associated with the specified
group. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The name of the group to list policies for.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional
policy names beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Container for the parameters to the GetUserPolicy operation.
Retrieves the specified policy document for the specified User.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Name of the User who the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document to get.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the GetGroup operation.
Returns a list of Users that are in the specified group. You can
paginate the results using the MaxItems and Marker
parameters.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
Name of the group.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of User names you want in the response. If there are additional User
names beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
AmazonIdentityManagementService exception
Constructs a new EntityAlreadyExistsException with the specified error
message.
Describes the error encountered.
Returns information about the DeleteLoginProfile response metadata.
The DeleteLoginProfile operation has a void result type.
Container for the parameters to the DeactivateMFADevice operation.
Deactivates the specified MFA device and removes it from
association with the User name for which it was originally
enabled.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the SerialNumber property
The value to set for the SerialNumber property
this instance
Name of the User whose MFA device you want to deactivate.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The serial number that uniquely identifies the MFA device.
Constraints:
-
Length
9 - 48
-
Pattern
[\w]*
The output for the DescribeJobFlows operation.
Adds elements to the JobFlows collection
The values to add to the JobFlows collection
this instance
A list of job flows matching the parameters supplied.
Reports the configuration of a bootstrap action in a job
flow.
Sets the BootstrapActionConfig property
The value to set for the BootstrapActionConfig property
this instance
A description of the bootstrap action.
Returns information about the AddInstanceGroupsResult response and response metadata.
Gets and sets the AddInstanceGroupsResult property.
Output from an AddInstanceGroups call.
Implemenation for accessing AmazonElasticMapReduce.
This is the Amazon Elastic MapReduce API Reference Guide. This
guide is for programmers who need detailed information about the
Amazon Elastic MapReduce APIs.
Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonElasticMapReduceClient with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonElasticMapReduceClient Configuration Object
AddInstanceGroups adds an instance group to a running
cluster.
Container for the necessary
parameters to execute the AddInstanceGroups service method on
AmazonElasticMapReduce.
The response from the AddInstanceGroups service method, as
returned by AmazonElasticMapReduce.
AddJobFlowSteps adds new steps to a running job flow. A maximum
of 256 steps are allowed in each job flow. A step
specifies the location of a JAR file stored either on the master node
of the job flow or in Amazon S3. Each step is performed by the main
function of the main class of the JAR file. The main class can be
specified either in the manifest of the JAR or by using the
MainFunction parameter of the step. Elastic MapReduce
executes each step in the order listed. For a step to be considered
complete, the main function must exit with a zero exit code and all
Hadoop jobs started while the step was running must have completed and
run successfully. You can only add steps to a job flow
that is in one of the following states: STARTING, BOOTSTAPPING,
RUNNING, or WAITING.
Container for the necessary
parameters to execute the AddJobFlowSteps service method on
AmazonElasticMapReduce.
TerminateJobFlows shuts a list of job flows down. When a job
flow is shut down, any step not yet completed is canceled and the EC2
instances on which the job flow is running are stopped. Any log files
not already saved are uploaded to Amazon S3 if a LogUri was specified
when the job flow was created.
Container for the necessary
parameters to execute the TerminateJobFlows service method on
AmazonElasticMapReduce.
DescribeJobFlows returns a list of job flows that match all of
the supplied parameters. The parameters can include a list of job flow
IDs, job flow states, and restrictions on job flow creation date and
time. Regardless of supplied parameters, only job flows
created within the last two months are returned. If no
parameters are supplied, then job flows matching either of the
following criteria are returned:
- Job flows created and completed in the last two weeks
- Job flows created within the last two months that are in one of
the following states: RUNNING ,
WAITING ,
SHUTTING_DOWN ,
STARTING
Amazon Elastic MapReduce can return a maximum of 512 job flow
descriptions.
Container for the necessary
parameters to execute the DescribeJobFlows service method on
AmazonElasticMapReduce.
The response from the DescribeJobFlows service method, as
returned by AmazonElasticMapReduce.
RunJobFlow creates and starts running a new job flow. The job
flow will run the steps specified. Once the job flow completes, the
cluster is stopped and the HDFS partition is lost. To prevent loss of
data, configure the last step of the job flow to store results in
Amazon S3. If the JobFlowInstancesDetail : KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE , the job flow will transition to the
WAITING state rather than shutting down once the steps have completed.
A maximum of 256 steps are allowed in each job
flow. For long running job flows, we recommended that you
periodically store your results.
Container for the necessary parameters
to execute the RunJobFlow service method on
AmazonElasticMapReduce.
The response from the RunJobFlow service method, as returned
by AmazonElasticMapReduce.
ModifyInstanceGroups modifies the number of nodes and
configuration settings of an instance group. The input parameters
include the new target instance count for the group and the instance
group ID. The call will either succeed or fail atomically.
Container for the necessary
parameters to execute the ModifyInstanceGroups service method on
AmazonElasticMapReduce.
HealthCheck Unmarshaller
Disable Availability Zones For Load Balancer Request Marshaller
Response Unmarshaller for DeregisterInstancesFromLoadBalancer operation
Delete Load Balancer Listeners Request Marshaller
Response Unmarshaller for CreateLoadBalancer operation
CreateLBCookieStickinessPolicyResult Unmarshaller
Create App Cookie Stickiness Policy Request Marshaller
AppCookieStickinessPolicy Unmarshaller
Contains the result of a successful invocation of DescribeLoadBalancers.
Default constructor for a new LoadBalancerDescription object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the DNSName property
The value to set for the DNSName property
this instance
Sets the CanonicalHostedZoneName property
The value to set for the CanonicalHostedZoneName property
this instance
Sets the CanonicalHostedZoneNameID property
The value to set for the CanonicalHostedZoneNameID property
this instance
Adds elements to the ListenerDescriptions collection
The values to add to the ListenerDescriptions collection
this instance
Adds elements to the ListenerDescriptions collection
The values to add to the ListenerDescriptions collection
this instance
Sets the Policies property
The value to set for the Policies property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Sets the HealthCheck property
The value to set for the HealthCheck property
this instance
Sets the SourceSecurityGroup property
The value to set for the SourceSecurityGroup property
this instance
Sets the CreatedTime property
The value to set for the CreatedTime property
this instance
Specifies the name associated with the LoadBalancer.
Specifies the external DNS name associated with the LoadBalancer.
Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your
load balancer with a hosted zone, go to Using Domain Names With
Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or
disassociate your load balancer with a hosted zone, go to Using Domain Names With
Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
LoadBalancerPort, InstancePort, Protocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.
Provides a list of policies defined for the LoadBalancer.
Specifies a list of Availability Zones.
Provides a list of EC2 instance IDs for the LoadBalancer.
Specifies information regarding the various health probes conducted on the LoadBalancer.
The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To
disallow traffic from sources other than your load balancer, add a security group rule to your back end instance that specifies this source
security group as the inbound source.
Provides the date and time the LoadBalancer was created.
Returns information about the EnableAvailabilityZonesForLoadBalancerResult response and response metadata.
Gets and sets the EnableAvailabilityZonesForLoadBalancerResult property.
The output for the EnableAvailabilityZonesForLoadBalancer action.
Returns information about the DescribeLoadBalancersResult response and response metadata.
Gets and sets the DescribeLoadBalancersResult property.
The output for the DescribeLoadBalancers action.
Returns information about the DeleteLoadBalancerPolicyResult response and response metadata.
Gets and sets the DeleteLoadBalancerPolicyResult property.
The output for the DeleteLoadBalancerPolicy action.
Container for the parameters to the UpdateApplicationVersion operation.
Updates the specified application version to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an
InvalidParameterValue error.
Constraints:
-
Length
1 - 100
The name of the version to update. If no application version is found with this label, UpdateApplication returns an
InvalidParameterValue error.
Constraints:
-
Length
1 - 100
A new description for this release.
Constraints:
-
Length
0 - 200
Trigger Unmarshaller
RetrieveEnvironmentInfoResult Unmarshaller
LoadBalancer Unmarshaller
Describe Environments Request Marshaller
Describe Configuration Options Request Marshaller
ApplicationVersionDescription Unmarshaller
AmazonElasticBeanstalk exception
Constructs a new SourceBundleDeletionException with the specified error
message.
Describes the error encountered.
Describes the details of a LoadBalancer.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Sets the Domain property
The value to set for the Domain property
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
Adds elements to the Listeners collection
The values to add to the Listeners collection
this instance
The name of the LoadBalancer.
The domain name of the LoadBalancer.
A list of Listeners used by the LoadBalancer.
Container for the parameters to the DescribeEnvironmentResources operation.
Returns AWS resources for this environment.
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
The ID of the environment to retrieve AWS resource usage data.
The name of the environment to retrieve AWS resource usage data.
Constraints:
-
Length
4 - 23
The results from a request to change the configuration settings of an environment.
Adds elements to the ConfigurationSettings collection
The values to add to the ConfigurationSettings collection
this instance
Adds elements to the ConfigurationSettings collection
The values to add to the ConfigurationSettings collection
this instance
A list of ConfigurationSettingsDescription.
Container for the parameters to the DeleteApplication operation.
Deletes the specified application along with all associated versions and configurations. NOTE:You cannot delete
an application that has a running environment.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
The name of the application to delete.
Constraints:
-
Length
1 - 100
Configuration for accessing AWS Elastic Beanstalk service
Default constructor
Gets the ServiceVersion property.
Information returned by a StopInstances request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if StopInstancesResult property is set
true if StopInstancesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the StopInstancesResult property.
Result of a StopInstances request.
Reason for the state change.
Sets the Code property
Reason code for the state change.
this instance
Checks if Code property is set
true if Code property is set
Sets the Message property
Message for the state change.
this instance
Checks if Message property is set
true if Message property is set
Gets and sets the Code property.
Reason code for the state change.
Gets and sets the Message property.
Message for the state change.
Reset Snapshot Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Releases an elastic IP address associated with
your account.
If you run this operation on an elastic IP address
that is already released,
the address might be assigned to another
account which will cause Amazon
EC2 to return an error.
Note -
releasing an IP address automatically disassociates it from any
instance with which it is associated. To disassociate an IP
address without
releasing it, use the DisassociateAddress
operation.
Important - after releasing an elastic IP address, it is
released to the IP
address pool and might no longer be available to
your account. Make sure
to update your DNS records and any servers
or devices that communicate with the address.
Sets the PublicIp property
The IP address that you are releasing from
your account.
this instance
Checks if PublicIp property is set
true if PublicIp property is set
Sets the AllocationId property
The allocation ID that AWS provided when you allocated
the address for use with Amazon VPC.
Type: String
Default: None
Condition: Required for VPC elastic IP addresses
this instance
Checks if AllocationId property is set
true if AllocationId property is set
Gets and sets the PublicIp property.
The IP address that you are releasing from
your account.
Gets and sets the AllocationId property.
The allocation ID that AWS provided when you allocated
the address for use with Amazon VPC.
Type: String
Default: None
Condition: Required for VPC elastic IP addresses
Specifies whether to enable monitoring for the
Spot Instance.
Sets the Enabled property
Enable monitoring for the Spot instance.
this instance
Checks if Enabled property is set
true if Enabled property is set
Gets and sets the Enabled property.
Enable monitoring for the Spot instance.
Import Volume Result
Checks if ConversionTask property is set
true if ConversionTask property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ConversionTask property.
Information about the import instance task.
Get Console Output Result
Checks if ConsoleOutput property is set
true if ConsoleOutput property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ConsoleOutput property.
Console output
Detach Volume Response
Checks if DetachVolumeResult property is set
true if DetachVolumeResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the DetachVolumeResult property.
Detach Volume Result
Gets and sets the ResponseMetadata property.
Response Metadata
Request to describe Spot Instance requests. Spot
Instances are instances that automatically launch
when your request price exceeds that Spot Price
that Amazon EC2 periodically calculates.
Sets the SpotInstanceRequestId property
The ID of the Spot Instance request.
this instance
Checks if SpotInstanceRequestId property is set
true if SpotInstanceRequestId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated
with the specified SpotInstances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the SpotInstanceRequestId property.
The ID of the Spot Instance request.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated
with the specified SpotInstances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Returns information about an attribute of an AMI.
Only one attribute can be specified per call.
Sets the ImageId property
The ID of the AMI for which an attribute will
be described.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the Attribute property
Attribute name to be described.Valid values:
launchPermission | productCodes | kernel
| ramdisk | blockDeviceMapping | platform
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the ImageId property.
The ID of the AMI for which an attribute will
be described.
Gets and sets the Attribute property.
Attribute name to be described.Valid values:
launchPermission | productCodes | kernel
| ramdisk | blockDeviceMapping | platform
Deletes a VPN connection. Use this if you want to delete a VPC and all
its associated components. Another reason to use this operation is
if you believe the tunnel credentials for your VPN connection
have been compromised.
In that situation, you can delete the VPN connection and create a
new one that has new keys, without needing to delete
the VPC or VPN gateway. If you create a new VPN
connection, you must reconfigure the customer
gateway using the new configuration information returned
with the new VPN connection ID.
If you're deleting the VPC and all its associated parts, we
recommend you detach the VPN gateway from the
VPC and delete the VPC before deleting the VPN
connection.
Sets the VpnConnectionId property
The ID of the VPN connection you want to
delete.
this instance
Checks if VpnConnectionId property is set
true if VpnConnectionId property is set
Gets and sets the VpnConnectionId property.
The ID of the VPN connection you want to
delete.
The Response for the
DeleteTags operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Deletes a security group that you own.
If you attempt to delete a security group that contains instances, a
fault is returned.
If you attempt to delete a security group that is referenced by
another security group, a fault is returned. For example,
if security group B has a rule that allows access from
security group A, security group A cannot be deleted until the
allow rule is removed.
Sets the GroupId property
ID of the security group to delete.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
Name of the security group to delete.
this instance
Checks if GroupName property is set
true if GroupName property is set
Gets and sets the GroupId property.
ID of the security group to delete.
Gets and sets the GroupName property.
Name of the security group to delete.
Information returned by the DeletePlacementGroup request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Delete Key Pair Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Deactivates a license.
Sets the LicenseId property
LicenseId property
this instance
Checks if LicenseId property is set
true if LicenseId property is set
Sets the Capacity property
Capacity property
this instance
Checks if Capacity property is set
true if Capacity property is set
Gets and sets the LicenseId property.
Gets and sets the Capacity property.
CreateNetworkAcl Result
Checks if NetworkAcl property is set
true if NetworkAcl property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the NetworkAcl property.
Information about the new network ACL.
Create Key Pair Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateKeyPairResult property is set
true if CreateKeyPairResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateKeyPairResult property.
Create Key Pair Result
Confirm Product Instance Result
Checks if OwnerId property is set
true if OwnerId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the OwnerId property.
The instance owner's account ID. Only present
if the product code is attached to the instance.
Attaches a VPN gateway to a VPC. This is the last step
required to get your VPC fully connected to your data center
before launching instances in it. For more information, go to
Process for Using Amazon VPC in the Amazon Virtual Private Cloud
Developer Guide.
Sets the VpnGatewayId property
The ID of the VPN gateway you want to attach
to the VPC.
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Sets the VpcId property
The ID of the VPC you want to attach to the
VPN gateway
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the VpnGatewayId property.
The ID of the VPN gateway you want to attach
to the VPC.
Gets and sets the VpcId property.
The ID of the VPC you want to attach to the
VPN gateway
Associate Address Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if AssociateAddressResult property is set
true if AssociateAddressResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the AssociateAddressResult property.
AssociateAddress Result
The output for the GetMetricStatistics action.
Sets the Label property
The value to set for the Label property
this instance
Adds elements to the Datapoints collection
The values to add to the Datapoints collection
this instance
Adds elements to the Datapoints collection
The values to add to the Datapoints collection
this instance
A label describing the specified metric.
The datapoints for the specified metric.
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.
Sets the MetricName property
The value to set for the MetricName property
this instance
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the Statistic property
The value to set for the Statistic property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the Period property
The value to set for the Period property
this instance
Sets the Unit property
The value to set for the Unit property
this instance
The name of the metric.
Constraints:
-
Length
1 - 255
The namespace of the metric.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The statistic for the metric.
Constraints:
-
Allowed Values
SampleCount, Average, Sum, Minimum, Maximum
The list of dimensions associated with the metric.
Constraints:
-
Length
0 - 10
The period in seconds over which the statistic is applied.
Constraints:
-
Range
60 -
The unit for the metric.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
Provides utilities used by the Amazon CloudFront client implementation.
Builds and returns the name value collection
that can be added to the HTTP headers for the request
The key to be added to the headers (eg. Content-Body)
The value of the key being added
A NameValueCollection with just one key-value pair
Computes RFC 2104-compliant HMAC signature
The data to be signed
The secret signing key
The algorithm to sign the data with
A string representing the HMAC signature
URL encodes a string. If the path property is specified,
the accepted characters {/:+} are not encoded.
The string to encode
Whether the string is a URL path or not
Formats the current date as a GMT timestamp
A GMT formatted string representation
of the current date and time
Creates a Key Value pair relating the key and value of type
T and U respectively
The type of the key
The type of the value
The default constructor
Constructs a Tuple relating an instance
of type T to an instance of type U
The key
The value
Returns the hash code for this tuple
A 32-bit signed integer hash code
Determines whether two Tuple objects have the same value.
true if obj is a String and its value is the same as this instance; otherwise, false.
Determines whether two Tuple objects have the same value.
true if obj is a String and its value is the same as this instance; otherwise, false.
Returns the key of this Tuple
Returns the value of this Tuple
S3 origin information to associate with the distribution.
Initializes a new instance of the S3Origin class.
Initializes a new instance of the S3Origin class.
The DNS name of your Amazon S3 bucket.
The origin access identity.
Sets the DNS name of your Amazon S3 bucket to associate with the distribution and
returns back this instance for method chaining.
The DNS name of your Amazon S3 bucket.
This instance
Sets the CloudFront origin access identity to associate with
the distribution. When the distribution is serving private
content this property must be set.
This instance is returned back for method chaining.
The origin access identity.
This instance
Gets or sets the DNS name of your Amazon S3 bucket to associate with the distribution.
For example: mybucket.s3.amazonaws.com.
The DNS name of your Amazon S3 bucket.
Gets or sets the CloudFront origin access identity to associate with
the distribution. When the distribution is serving private
content this property must be set.
The origin access identity.
The GetStreamingDistributionInfoRequest contains the parameters used for the GetStreamingDistributionInfo operation.
Required Parameter: Id
Sets the Id property of this request to the value passed in.
The StreamingDistribution's id
The request with the Id property set
Gets and sets the Id property for the StreamingDistribution
The GetStreamingDistributionConfigRequest contains the parameters used for the GetStreamingDistributionConfig operation.
Required Parameters: Id
Sets the Id property of this request to the value passed in.
The StreamingDistribution's id
The request with the Id property set
Gets and sets the Id property for the StreamingDistribution
The DeleteDistributionResponse contains any headers returned by CloudFront.
The DeleteDistributionRequest contains the parameters used for the DeleteDistribution operation.
Required Parameters: Id
Required Parameters: ETag
Sets the Id property of this request to the value passed in.
The distribution's id
The request with the Id property set
Sets the ETag property of this request to the value passed in.
The distribution's etag
The request with the ETag property set
Gets and sets the Id property for the Distribution
Gets and sets the ETag property for the Distribution
The CreateOriginAccessIdentityRequest contains the parameters used for the CreateOriginAccessIdentity operation.
Sets the OriginAccessIdentityConfig property for this request.
The value that OriginAccessIdentityConfig is set to
the request with the Id set
Gets and Sets the OriginAccessIdentityConfig property.
Configuration for Amazon CloudFront Client.
Sets the ServiceURL property
ServiceURL property
this instance
Checks if ServiceURL property is set
true if ServiceURL property is set
Sets the UserAgent property
UserAgent property
this instance
Checks if UserAgent property is set
true if UserAgent property is set
Sets the ProxyHost property
ProxyHost property
this instance
Checks if ProxyHost property is set
true if ProxyHost property is set
Sets the ProxyPort property
ProxyPort property
this instance
Checks if ProxyPort property is set
true if ProxyPort property is set
Sets the MaxErrorRetry property
MaxErrorRetry property
this instance
Checks if MaxErrorRetry property is set
true if MaxErrorRetry property is set
Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Whether a secure string should be used or not.
The Config object with the property set
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Sets the ProxyUsername property
Value for the ProxyUsername property
this instance
Checks if ProxyUsername property is set
true if ProxyUsername property is set
Sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
ProxyPassword property
this instance
Checks if ProxyPassword property is set
true if ProxyPassword property is set
Gets and sets of the ServiceURL property.
Gets and sets of the UserAgent property.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
The Stack data type.
Sets the StackId property
The value to set for the StackId property
this instance
Sets the StackName property
The value to set for the StackName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Sets the CreationTime property
The value to set for the CreationTime property
this instance
Sets the StackStatus property
The value to set for the StackStatus property
this instance
Sets the StackStatusReason property
The value to set for the StackStatusReason property
this instance
Sets the DisableRollback property
The value to set for the DisableRollback property
this instance
Adds elements to the NotificationARNs collection
The values to add to the NotificationARNs collection
this instance
Adds elements to the NotificationARNs collection
The values to add to the NotificationARNs collection
this instance
Sets the TimeoutInMinutes property
The value to set for the TimeoutInMinutes property
this instance
Adds elements to the Outputs collection
The values to add to the Outputs collection
this instance
Adds elements to the Outputs collection
The values to add to the Outputs collection
this instance
Unique identifier of the stack.
The name associated with the stack.
User defined description associated with the stack.
A list of Parameter structures.
Time at which the stack was created.
Current status of the stack.
Constraints:
-
Allowed Values
CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE
Success/failure message associated with the stack status.
Boolean to enable or disable rollback on stack creation failures: - true: disable rollback
- false: enable
rollback
SNS topic ARNs to which stack related events are published.
Constraints:
-
Length
0 - 5
The amount of time within which stack creation should complete.
Constraints:
-
Range
1 -
A list of output structures.
The output for a DescribeStacks action.
Adds elements to the Stacks collection
The values to add to the Stacks collection
this instance
Adds elements to the Stacks collection
The values to add to the Stacks collection
this instance
A list of stack structures.
Execute Policy Request Marshaller
Create Auto Scaling Group Request Marshaller
Container for the parameters to the PutScheduledUpdateGroupAction operation.
Creates a scheduled scaling action for a Auto Scaling group. If you leave a parameter unspecified, the corresponding value remains
unchanged in the affected Auto Scaling group.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the ScheduledActionName property
The value to set for the ScheduledActionName property
this instance
Sets the Time property
The value to set for the Time property
this instance
Sets the MinSize property
The value to set for the MinSize property
this instance
Sets the MaxSize property
The value to set for the MaxSize property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
The name or ARN of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of this scaling action.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The time for this action to start.
The minimum size for the new Auto Scaling group.
The maximum size for the Auto Scaling group.
The number of EC2 instances that should be running in the group.
Returns information about the DescribePoliciesResult response and response metadata.
Gets and sets the DescribePoliciesResult property.
The PoliciesType data type.
Returns information about the DeletePolicy response metadata.
The DeletePolicy operation has a void result type.
Returns information about the DeleteLaunchConfiguration response metadata.
The DeleteLaunchConfiguration operation has a void result type.
Container for the parameters to the DeleteAutoScalingGroup operation.
Deletes the specified auto scaling group if the group has no instances and no scaling activities in progress.
NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and
maximum size of the AutoScalingGroup to zero.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Encapsulates the metadata and result of the Publish action.
Checks if PublishResult property is set
true if PublishResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the PublishResult property.
Encapsulates the result of the Publish action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
Encapsulates the metadata and result of the DeleteTopic action.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
List Verified Email Addresses Request Marshaller
Represents a list of all the email addresses verified for the
current user.
Adds elements to the VerifiedEmailAddresses collection
The values to add to the VerifiedEmailAddresses collection
this instance
Adds elements to the VerifiedEmailAddresses collection
The values to add to the VerifiedEmailAddresses collection
this instance
Returns all of the attributes associated with the item. Optionally, the attributes returned can be limited to
one or more specified attribute name parameters.
If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The
system does not return an error as it cannot guarantee the item does not exist on other replicas.
If you do not specify any attribute names, all the attributes for the item are returned.
Sets the DomainName property
The name of the domain in which to perform the operation.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the ItemName property
The name of the item in which to perform the operation.
this instance
Checks if ItemName property is set
true if ItemName property is set
Sets the AttributeName property
The name of the attribute.
this instance
Checks if AttributeName property is set
true if AttributeName property is set
Sets the ConsistentRead property
If set to true, this flag ensures that the most recently written data is
returned.
this instance
Checks if ConsistentRead property is set
true if ConsistentRead property is set
Gets and sets the DomainName property.
The name of the domain in which to perform the operation.
Gets and sets the ItemName property.
The name of the item in which to perform the operation.
Gets and sets the AttributeName property.
The name of the attribute.
Gets and sets the ConsistentRead property.
If set to true, this flag ensures that the most recently written data is
returned.
DeleteableItem contains an item name and a list of that will be deleted.
If no attributes are entered then the whole item will be deleted.
Sets the ItemName property
The name of the item.
this instance
Checks if ItemName property is set
true if ItemName property is set
Sets the Attribute property
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the ItemName property.
The name of the item.
Gets and sets the Attribute property.
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
Returns metadata about the response, including box usage and request ID.
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Contains all the parameters
that can be set when making a this request with the
TransferUtility method.
The base class for requests that return Amazon S3 objects.
Gets whether or not the bucket name is set.
A value of true if the bucket name is set.
Returns false if otherwise.
Gets whether or not the key property is set.
A value of true if key property is set.
Returns false if otherwise.
Checks if VersionId property is set.
true if VersionId property is set.
Checks if ModifiedSinceDate property is set.
true if ModifiedSinceDate property is set.
Checks if UnmodifiedSinceDate property is set.
true if UnmodifiedSinceDate property is set.
Gets or sets the name of the bucket.
The name of the bucket.
Gets or sets the key under which the Amazon S3 object is stored.
The key under which the Amazon S3 object is stored.
Gets or sets the version ID of the Amazon S3 object.
The version ID of the Amazon S3 object.
Gets or sets the ModifiedSinceDate property.
The ModifiedSinceDate property.
Gets or sets the UnmodifiedSinceDate property.
The UnmodifiedSinceDate property.
Gets or sets the timeout property in milliseconds.
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for Amazon S3 GET Object requests.
A value less than or equal to 0 will be silently ignored.
Sets the bucket name containing the Amazon S3 object to download and returns
this object instance, enabling additional method calls to
be chained together.
The name of the bucket containing the Amazon S3 object to download.
This object instance, enabling additional method calls to be chained together.
Sets the key under which the Amazon S3 object is stored and returns
this object instance, enabling additional method calls to be chained together.
The key under which the Amazon S3 object is stored.
This object instance, enabling additional method calls to be chained together.
Sets the version ID of the Amazon S3 object to download
and returns this object instance,
enabling additional method calls to be chained together.
The version ID of the Amazon S3 object to download.
This object instance, enabling additional method calls to be chained together.
Sets the ModifiedSinceDate property for this request
and returns this object instance,
enabling additional method calls to be chained together.
When this property is set, the Amazon S3 object is returned only if it
has been modified since the specified time. Otherwise,
this requests returns a 304 error code.
The ModifiedSinceDate value.
This object instance, enabling additional method calls to be chained together.
Sets the UnmodifiedSinceDate property for this request
and returns this object instance,
enabling additional method calls to be chained together.
When this property is set, the Amazon S3 object is returned only if it
has not been modified since the specified time. Otherwise,
this requests returns a 412 error code.
The UnmodifiedSinceDate value.
This object instance, enabling additional method calls to be chained together.
Sets the timeout property in milliseconds.
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for Amazon S3 GET Object requests.
Specify a timeout value only if certain that
the file will not be retrieved within the default intervals
specified for the HttpWebRequest.
The timeout property in milliseconds.
A value less than or equal to 0 will be silently ignored.
This object instance, enabling additional method calls to be chained together.
Checks if FilePath property is set.
true if FilePath property is set.
Sets the file path location of where the
downloaded Amazon S3 object will be written to
and returns this object instance,
enabling additional method calls to be chained together.
The file path location of where the
downloaded Amazon S3 object will be written to.
This object instance, enabling additional method calls to be chained together.
The handler will be attached to the WriteObjectProgressEvent which is fired as data
is downloaded from S3. The handler will be passed information detailing how much data
has been downloaded as well as how much will be downloaded.
A method that is called when WriteObjectProgressEvent is fired.
this instance of the TransferUtilityDownloadRequest
Get or sets the file path location of where the
downloaded Amazon S3 object will be written to.
The file path location of where the downloaded Amazon S3 object will be written to.
The event for WriteObjectProgressEvent notifications. All
subscribers will be notified when a new progress
event is raised.
The WriteObjectProgressEvent is fired as data
is downloaded from S3. The delegates attached to the event
will be passed information detailing how much data
has been downloaded as well as how much will be downloaded.
Subscribe to this event if you want to receive
WriteObjectProgressEvent notifications. Here is how:
1. Define a method with a signature similar to this one:
private void displayProgress(object sender, WriteObjectProgressArgs args)
{
Console.WriteLine(args);
}
2. Add this method to the WriteObjectProgressEvent delegate's invocation list
TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest();
request.WriteObjectProgressEvent += displayProgress;
The CopyObjectRequest contains the parameters used for the CopyObject operation.
For more information about the optional parameters, refer:
Required Parameters: SourceBucket, SourceKey, DestinationBucket
Optional Parameters: DestinationKey, ETagToMatch, ETagToNotMatch, ModifiedSinceDate,
UnmodifiedSinceDate, Directive, Metadata, CannedACL, Timeout, SourceVersionId,
StorageClass
Sets the SourceBucket property for this request.
This is the S3Bucket that contains the S3 Object you
want to copy.
The value that SourceBucket is set to
the response with the SourceBucket set
Checks if SourceBucket property is set.
true if SourceBucket property is set.
Sets the SourceKey property for this request.
This is the S3Object you want to copy.
The value that SourceKey is set to
the response with the SourceKey set
Checks if SourceKey property is set.
true if SourceKey property is set.
Sets the DestinationBucket property for this request.
This is the S3 Bucket where the copied S3 Object is put.
The value that DestinationBucket is set to
the response with the DestinationBucket set
Checks if DestinationBucket property is set.
true if DestinationBucket property is set.
Sets the DestinationKey property for this request.
This is the key for the new S3 Object that is copied.
The value that DestinationKey is set to
the response with the Destinationkey set
Checks if DestinationKey property is set.
true if DestinationKey property is set.
Sets the ContentType property for this request.
the value the ContentType to be set to
The request with the ContentType set
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
This property is passed on to S3 only if the metadata
directive is REPLACE.
Checks if ContentType property is set.
true if ContentType property is set.
Sets the ETagToMatch property for this request.
Copies the object if its entity tag (ETag) matches
the specified tag; otherwise return a 412 (precondition failed).
Constraints: This property can be used with IfUnmodifiedSince,
but cannot be used with other conditional copy properties.
The value that ETagToMatch is set to
this instance
Checks if ETagToMatch property is set.
true if ETagToMatch property is set.
Sets the ETagToNotMatch property for this request.
Copies the object if its entity tag (ETag) is different
than the specified Etag; otherwise returns a 412 (failed condition).
Constraints: This header can be used with IfModifiedSince, but cannot
be used with other conditional copy properties.
The value that ETagToNotMatch is set to
this instance
Checks if ETagToNotMatch property is set.
true if ETagToNotMatch property is set.
Sets the ModifiedSinceDate property for this request.
Copies the object if it has been modified since the
specified time; otherwise returns a 412 (failed condition).
Constraints: This property can be used with ETagToNotMatch,
but cannot be used with other conditional copy properties.
The value that ModifiedSinceDate is set to
this instance
Checks if ModifiedSinceDate property is set.
true if ModifiedSinceDate property is set.
Sets the UnmodifiedSinceDate property for this request.
Copies the object if it hasn't been modified since the
specified time; otherwise returns a 412 (precondition failed).
Constraints: This property can be used with ETagToMatch,
but cannot be used with other conditional copy properties.
The value that UnmodifiedSinceDate is set to
this instance
Checks if UnmodifiedSinceDate property is set.
true if UnmodifiedSinceDate property is set.
Sets the Directive property for this request. The
default value for the directive is COPY.
The value that Directive is set to
the response with the Directive set
Specifies whether the metadata is copied from
the source object or replaced with metadata
provided in the request. If COPY, the metadata remains
unchanged, otherwise, all original metadata is
replaced by the metadata you specify.
You cannot copy an object to itself unless the Directive
property is specified and its value set to REPLACE.
Adds a key/value pair to the Metadata property for this request.
The S3 Object that you copy will have this metadata associated
with it.
The key to associate with the object
The value for the key
The response with Metadata set.
Adds a set of key-value pairs to the request
The set of key-value pairs that will eventually be
associated with the S3 Object
Checks if Metadata property is set.
true if Metadata property is set.
Removes a key from the Metadata list if it was
added previously
The key to remove
Sets the CannedACL property for this request.
If set the S3 Object will have this CannedACL
permission.
The Canned ACL to be set on the object
The request with the CannedACL set
Checks if the S3CannedACL property is set.
true if there is the S3CannedACL property is set.
Resets the S3CannedACL
Sets the Timeout property (in milliseconds).
Please set the timeout only if you are certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
Timeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout property of the HttpWebRequest.
ReadWriteTimeout property
A value less than or equal to 0 will be silently ignored
this instance
Sets the SourceVersionId property for this request.
This is the SourceVersionId for the S3 Object you want to Get.
The value that SourceVersionId is set to
this instance
Checks if SourceVersionId property is set.
true if SourceVersionId property is set.
Sets the StorageClass property for the destination object.
Default: The S3StorageClass of the source object.
Set this property only if you want to change the storage
class of the destination object. Please refer
for
information on S3 Storage Classes.
The Storage Class to be set on the object
The request with the StorageClass set
Gets and sets the SourceBucket property.
Gets and sets the SourceKey property.
Gets and sets the DestinationBucket property.
Gets and sets the DestinationKey property.
Gets and sets the ContentType property.
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
This property is passed on to S3 only if the metadata
directive is REPLACE.
Gets and sets the ETagToMatch property.
Gets and sets the ETagToNotMatch property.
Gets and sets the ModifiedSinceDate property.
Gets and sets the UnmodifiedSinceDate property.
Gets and sets the Directive property. Default is COPY.
Specifies whether the metadata is copied from
the source object or replaced with metadata
provided in the request. If COPY, the metadata remains
unchanged, otherwise, all original metadata is
replaced by the metadata you specify.
You cannot copy an object to itself unless the Directive
property is specified and its value set to REPLACE.
Gets and sets the CannedACL property.
Gets and sets of the Timeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for S3 COPY requests.
A value less than or equal to 0 will be silently ignored
Gets and sets of the ReadWriteTimeout property (in milliseconds).
The value of this property is assigned to the
ReadWriteTimeout properties of the
HTTPWebRequest object used for S3 COPY requests.
A value less than or equal to 0 will be silently ignored
Gets and sets the SourceVersionId property.
Gets and sets the StorageClass property.
Default: The S3StorageClass of the source object.
Set this property only if you want to change the storage
class of the destination object. Please refer
for
information on S3 Storage Classes.
Represents an error returned by the S3 service. Exposes
an error code, a message, a host ID and a request ID for
debugging purposes.
Gets and sets the Code property.
Gets and sets the Message property.
Gets and sets the HostId property.
Gets and sets the RequestId property.
Gets and sets the UploadId property.
Gets and sets the ETag property.
The DeleteBucketWebsiteRequest contains the parameters used for the DeleteBucketWebsiteRequest operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
This is the S3 Bucket where the website configuration will be deleted.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
The AbortMultipartUploadResponse contains any headers returned by S3.
Result Unmarshaller for RestoreDBInstanceFromDBSnapshot operation
Describe Orderable D B Instance Options Request Marshaller
Describe Engine Default Parameters Request Marshaller
DBParameterGroup Unmarshaller
Result Unmarshaller for CreateDBInstance operation
Create D B Instance Request Marshaller
Response Unmarshaller for AuthorizeDBSecurityGroupIngress operation
Container for the parameters to the DescribeReservedDBInstances operation.
Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
Sets the ReservedDBInstanceId property
The value to set for the ReservedDBInstanceId property
this instance
Sets the ReservedDBInstancesOfferingId property
The value to set for the ReservedDBInstancesOfferingId property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the Duration property
The value to set for the Duration property
this instance
Sets the ProductDescription property
The value to set for the ProductDescription property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation
ID.
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values:
1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the
response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to
MaxRecords.
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the DBParameterGroups collection
The values to add to the DBParameterGroups collection
this instance
Adds elements to the DBParameterGroups collection
The values to add to the DBParameterGroups collection
this instance
The marker obtained from a previous operation response.
A list of DBParameterGroup instances.
Returns information about the DeleteDBParameterGroup response metadata.
The DeleteDBParameterGroup operation has a void result type.
Returns information about the CreateDBParameterGroup response and response metadata.
Gets and sets the CreateDBParameterGroupResult property.
Contains the result of a successful invocation of the CreateDBParameterGroup
action.
Container for the parameters to the CreateDBInstanceReadReplica operation.
Creates a DB Instance that acts as a Read Replica of a source DB Instance. All Read Replica DB Instances are created
as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are
inherited from the source DB Instance, except as specified below. IMPORTANT: The source DB Instance must have backup
retention enabled.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the SourceDBInstanceIdentifier property
The value to set for the SourceDBInstanceIdentifier property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the AvailabilityZone property
The value to set for the AvailabilityZone property
this instance
Sets the Port property
The value to set for the Port property
this instance
Sets the AutoMinorVersionUpgrade property
The value to set for the AutoMinorVersionUpgrade property
this instance
The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a
lowercase string.
The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.
Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.
The compute and memory capacity of the Read Replica. Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge
| db.m2.4xlarge Default: Inherits from the source DB Instance.
The Amazon EC2 Availability Zone that the Read Replica will be created in. Default: A random, system-chosen Availability Zone in the
endpoint's region. Example: us-east-1d
The port number that the DB Instance uses for connections. Default: Inherits from the source DB Instance Valid Values: 1150-65535
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from
the source DB Instance
Contains Availability Zone information. This data type is used as an element in the following data type:
- OrderableDBInstanceOption
Sets the Name property
The value to set for the Name property
this instance
The name of the availability zone.
Output structure for the GetStatus operation.
Sets the JobId property
The value to set for the JobId property
this instance
Sets the JobType property
The value to set for the JobType property
this instance
Sets the AwsShippingAddress property
The value to set for the AwsShippingAddress property
this instance
Sets the LocationCode property
The value to set for the LocationCode property
this instance
Sets the LocationMessage property
The value to set for the LocationMessage property
this instance
Sets the ProgressCode property
The value to set for the ProgressCode property
this instance
Sets the ProgressMessage property
The value to set for the ProgressMessage property
this instance
Sets the Carrier property
The value to set for the Carrier property
this instance
Sets the TrackingNumber property
The value to set for the TrackingNumber property
this instance
Sets the LogBucket property
The value to set for the LogBucket property
this instance
Sets the LogKey property
The value to set for the LogKey property
this instance
Sets the ErrorCount property
The value to set for the ErrorCount property
this instance
Sets the Signature property
The value to set for the Signature property
this instance
Sets the SignatureFileContents property
The value to set for the SignatureFileContents property
this instance
Sets the CurrentManifest property
The value to set for the CurrentManifest property
this instance
Sets the CreationDate property
The value to set for the CreationDate property
this instance
A unique identifier which refers to a particular job.
Specifies whether the job to initiate is an import or export job.
Constraints:
-
Allowed Values
Import, Export
Address you ship your storage device to.
A token representing the location of the storage device, such as
"AtAWS".
A more human readable form of the physical location of the storage
device.
A token representing the state of the job, such as "Started".
A more human readable form of the job status.
Name of the shipping company. This value is included when the
LocationCode is "Returned".
The shipping tracking number assigned by AWS Import/Export to the
storage device when it's returned to you. We return this value when
the LocationCode is "Returned".
Amazon S3 bucket for user logs.
The key where the user logs were stored.
Number of errors. We return this value when the ProgressCode is
Success or SuccessWithErrors.
An encrypted code used to authenticate the request and response, for
example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you
want to create the signature file yourself. Generally you should use
the SignatureFileContents value.
An encrypted code used to authenticate the request and response, for
example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you
want to create the signature file yourself. Generally you should use
the SignatureFileContents value.
The last manifest submitted, which will be used to process the job.
Timestamp of the CreateJob request in ISO8601 date format. For example
"2010-03-28T20:27:35Z".
AmazonImportExport exception
Constructs a new ExpiredJobIdException with the specified error
message.
Describes the error encountered.
Utility constants for Amazon.IdentityManagament.
Active value for Amazon.IdentityManagement.Model.SigningCertificate.Status.
Inctive value for Amazon.IdentityManagement.Model.SigningCertificate.Status.
Container for the parameters to the UploadSigningCertificate operation.
Uploads an X.509 signing certificate and associates it with the
specified User. Some AWS services use X.509 signing certificates to
validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is Active
. If the UserName field is not specified, the User
name is determined implicitly based on the AWS Access Key ID used to
sign the request. Because this action works for access keys under the
AWS Account, this API can be used to manage root credentials even if
the AWS Account has no associated Users.
NOTE:Because the body of a X.509 certificate can be
large, you should use POST rather than GET when calling
UploadSigningCertificate. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the CertificateBody property
The value to set for the CertificateBody property
this instance
Name of the User the signing certificate is for.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The contents of the signing certificate.
Constraints:
-
Length
1 - 16384
-
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+
Response Unmarshaller for UploadServerCertificate operation
Update Login Profile Request Marshaller
Response Unmarshaller for DeleteSigningCertificate operation
Create User Request Marshaller
Returns information about the PutGroupPolicy response metadata.
The PutGroupPolicy operation has a void result type.
Contains the result of a successful invocation of the
ListServerCertificates action.
Adds elements to the ServerCertificateMetadataList collection
The values to add to the ServerCertificateMetadataList collection
this instance
Adds elements to the ServerCertificateMetadataList collection
The values to add to the ServerCertificateMetadataList collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of server certificates.
A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent
pagination request using the Marker request parameter to retrieve more server certificates in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the ListGroupsResult response and response metadata.
Gets and sets the ListGroupsResult property.
Contains the result of a successful invocation of the ListGroups action.
Container for the parameters to the ListGroups operation.
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and
Marker parameters.
Sets the PathPrefix property
The value to set for the PathPrefix property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all groups whose path starts
with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all
groups.
Constraints:
-
Length
1 - 512
-
Pattern
\u002F[\u0021-\u007F]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups
beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Returns information about the EnableMFADevice response metadata.
The EnableMFADevice operation has a void result type.
Container for the parameters to the DeleteUser operation.
Deletes the specified User. The User must not belong to any
groups, have any keys or signing certificates, or have any attached
policies.
Sets the UserName property
The value to set for the UserName property
this instance
Name of the User to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the DeleteUserPolicy operation.
Deletes the specified policy associated with the specified
User.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Name of the User the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the DeleteLoginProfile operation.
Deletes the login profile for the specified User, which
terminates the User's ability to access AWS services through the IAM
login page. IMPORTANT:Deleting a User's login
profile does not prevent a User from accessing IAM through the command
line interface or the API. To prevent all User access you must also
either make the access key inactive or delete it. For more
information about making keys inactive or deleting them, see
UpdateAccessKey and DeleteAccessKey.
Sets the UserName property
The value to set for the UserName property
this instance
Name of the User whose login profile you want to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Returns information about the CreateUserResult response and response metadata.
Gets and sets the CreateUserResult property.
Contains the result of a successful invocation of the CreateUser action.
Container for the parameters to the CreateAccountAlias operation.
This action creates an alias for your AWS Account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
.
Sets the AccountAlias property
The value to set for the AccountAlias property
this instance
Name of the account alias to create
Constraints:
-
Length
3 - 63
-
Pattern
^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$
Returns information about the CreateAccessKeyResult response and response metadata.
Gets and sets the CreateAccessKeyResult property.
Contains the result of a successful invocation of the CreateAccessKey action.
Implemenation for accessing AmazonIdentityManagementService.
AWS Identity and Access Management This is the AWS Identity and
Access Management (IAM) API Reference. This guide provides
descriptions of the IAM API as well as links to related content in the
guide, Using IAM. AWS Identity and Access Management
(IAM) is a web service that enables Amazon Web Services (AWS)
customers to manage Users and User permissions under their AWS
Account. For more information about this product go to
AWS Identity and Access Management (IAM). For specific information
about setting up signatures and authorization through the API, go to
Making Query Requests in the Using IAM guide. If you're
new to AWS and need additional technical information about a specific
AWS product, you can find the product's technical documentation at
http://aws.amazon.com/documentation/. We will refer to
Amazon AWS Identity and Access Management using the abbreviated form
IAM. All copyrights and legal protections still apply.
Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID, AWS Secret Key and an
AmazonS3 Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonIdentityManagementServiceClient Configuration Object
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary parameters
to execute the ListGroups service method on
AmazonIdentityManagementService.
The response from the ListGroups service method, as returned
by AmazonIdentityManagementService.
Deletes the access key associated with the specified
User. If you do not specify a User name, IAM determines
the User name implicitly based on the AWS Access Key ID signing the
request. Because this action works for access keys under the AWS
Account, you can use this API to manage root credentials even if the
AWS Account has no associated Users.
Container for the necessary
parameters to execute the DeleteAccessKey service method on
AmazonIdentityManagementService.
Deletes the specified AWS Account alias. For information about
using an AWS Account alias, see Using an Alias for Your AWS Account ID
in Using AWS Identity and Access Management .
Container for the necessary
parameters to execute the DeleteAccountAlias service method on
AmazonIdentityManagementService.
Returns information about the signing certificates associated
with the specified User. If there are none, the action returns an
empty list. Although each User is limited to a small
number of signing certificates, you can still paginate the results
using the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is
determined implicitly based on the AWS Access Key ID used to sign the
request. Because this action works for access keys under the AWS
Account, this API can be used to manage root credentials even if the
AWS Account has no associated Users.
Container for the
necessary parameters to execute the ListSigningCertificates service
method on AmazonIdentityManagementService.
The response from the ListSigningCertificates service method,
as returned by AmazonIdentityManagementService.
Uploads an X.509 signing certificate and associates it with the
specified User. Some AWS services use X.509 signing certificates to
validate requests that are signed with a corresponding private key.
When you upload the certificate, its default status is Active
. If the UserName field is not specified, the User
name is determined implicitly based on the AWS Access Key ID used to
sign the request. Because this action works for access keys under the
AWS Account, this API can be used to manage root credentials even if
the AWS Account has no associated Users.
NOTE:Because the body of a X.509 certificate can be
large, you should use POST rather than GET when calling
UploadSigningCertificate. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Container for the
necessary parameters to execute the UploadSigningCertificate service
method on AmazonIdentityManagementService.
The response from the UploadSigningCertificate service
method, as returned by AmazonIdentityManagementService.
Deletes the specified policy associated with the specified
User.
Container for the necessary
parameters to execute the DeleteUserPolicy service method on
AmazonIdentityManagementService.
Adds (or updates) a policy document associated with the
specified User. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a User, see Limitations on IAM Entities in Using AWS
Identity and Access Management . NOTE:Because
policy documents can be large, you should use POST rather than GET
when calling PutUserPolicy. For more information, see Making Query
Requests in Using AWS Identity and Access Management.
Container for the necessary
parameters to execute the PutUserPolicy service method on
AmazonIdentityManagementService.
Lists the server certificates that have the specified path
prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the
necessary parameters to execute the ListServerCertificates service
method on AmazonIdentityManagementService.
The response from the ListServerCertificates service method,
as returned by AmazonIdentityManagementService.
Retrieves the specified policy document for the specified User.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Container for the necessary
parameters to execute the GetUserPolicy service method on
AmazonIdentityManagementService.
The response from the GetUserPolicy service method, as
returned by AmazonIdentityManagementService.
Updates the login profile for the specified User. Use this API
to change the User's password.
Container for the necessary
parameters to execute the UpdateLoginProfile service method on
AmazonIdentityManagementService.
Updates the name and/or the path of the specified server
certificate. IMPORTANT: You should understand the
implications of changing a server certificate's path or name. For more
information, see Managing Server Certificates in Using AWS Identity
and Access Management. NOTE:To change a server
certificate name the requester must have appropriate permissions on
both the source object and the target object. For example, to change
the name from ProductionCert to ProdCert, the entity making the
request must have permission on ProductionCert and ProdCert, or must
have permission on all (*). For more information about permissions,
see Permissions and Policies.
Container for the
necessary parameters to execute the UpdateServerCertificate service
method on AmazonIdentityManagementService.
Updates the name and/or the path of the specified User.
IMPORTANT: You should understand the implications of
changing a User's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a User name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Bob to Robert, the entity making the
request must have permission on Bob and Robert, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Container for the necessary parameters
to execute the UpdateUser service method on
AmazonIdentityManagementService.
Deletes the login profile for the specified User, which
terminates the User's ability to access AWS services through the IAM
login page. IMPORTANT:Deleting a User's login
profile does not prevent a User from accessing IAM through the command
line interface or the API. To prevent all User access you must also
either make the access key inactive or delete it. For more
information about making keys inactive or deleting them, see
UpdateAccessKey and DeleteAccessKey.
Container for the necessary
parameters to execute the DeleteLoginProfile service method on
AmazonIdentityManagementService.
Changes the status of the specified signing certificate from
active to disabled, or vice versa. This action can be used to disable
a User's signing certificate as part of a certificate rotation
workflow. If the UserName field is not specified,
the UserName is determined implicitly based on the AWS Access Key ID
used to sign the request. Because this action works for access keys
under the AWS Account, this API can be used to manage root credentials
even if the AWS Account has no associated Users. For
information about rotating certificates, see Managing Keys and
Certificates in Using AWS Identity and Access Management
.
Container for the
necessary parameters to execute the UpdateSigningCertificate service
method on AmazonIdentityManagementService.
Deletes the specified policy that is associated with the
specified group.
Container for the necessary
parameters to execute the DeleteGroupPolicy service method on
AmazonIdentityManagementService.
Lists the Users that have the specified path prefix. If there
are none, the action returns an empty list. You can
paginate the results using the MaxItems and Marker
parameters.
Container for the necessary parameters
to execute the ListUsers service method on
AmazonIdentityManagementService.
The response from the ListUsers service method, as returned
by AmazonIdentityManagementService.
Updates the name and/or the path of the specified group.
IMPORTANT: You should understand the implications of
changing a group's path or name. For more information, see Renaming
Users and Groups in Using AWS Identity and Access Management.
NOTE:To change a group name the requester must have
appropriate permissions on both the source object and the target
object. For example, to change Managers to MGRs, the entity making
the request must have permission on Managers and MGRs, or must have
permission on all (*). For more information about permissions, see
Permissions and Policies.
Container for the necessary
parameters to execute the UpdateGroup service method on
AmazonIdentityManagementService.
Retrieves information about the specified server
certificate.
Container for the necessary
parameters to execute the GetServerCertificate service method on
AmazonIdentityManagementService.
The response from the GetServerCertificate service method, as
returned by AmazonIdentityManagementService.
Adds (or updates) a policy document associated with the
specified group. For information about policies, refer to Overview of
Policies in Using AWS Identity and Access Management .
For information about limits on the number of policies you can
associate with a group, see Limitations on IAM Entities in Using
AWS Identity and Access Management .
NOTE:Because policy documents can be large, you should
use POST rather than GET when calling PutGroupPolicy. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Container for the necessary
parameters to execute the PutGroupPolicy service method on
AmazonIdentityManagementService.
Creates a new User for your AWS Account. For
information about limitations on the number of Users you can create,
see Limitations on IAM Entities in Using AWS Identity and Access
Management .
Container for the necessary parameters
to execute the CreateUser service method on
AmazonIdentityManagementService.
The response from the CreateUser service method, as returned
by AmazonIdentityManagementService.
Deletes the specified signing certificate associated with the
specified User. If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users.
Container for the
necessary parameters to execute the DeleteSigningCertificate service
method on AmazonIdentityManagementService.
Enables the specified MFA device and associates it with the
specified User name. When enabled, the MFA device is required for
every subsequent login by the User name associated with the
device.
Container for the necessary
parameters to execute the EnableMFADevice service method on
AmazonIdentityManagementService.
Lists the names of the policies associated with the specified
User. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary
parameters to execute the ListUserPolicies service method on
AmazonIdentityManagementService.
The response from the ListUserPolicies service method, as
returned by AmazonIdentityManagementService.
Returns information about the Access Key IDs associated with the
specified User. If there are none, the action returns an empty
list. Although each User is limited to a small number of
keys, you can still paginate the results using the MaxItems and
Marker parameters. If the UserName field is
not specified, the UserName is determined implicitly based on the AWS
Access Key ID used to sign the request. Because this action works for
access keys under the AWS Account, this API can be used to manage root
credentials even if the AWS Account has no associated Users.
NOTE:To ensure the security of your AWS Account, the
secret access key is accessible only during key and User
creation.
Container for the necessary
parameters to execute the ListAccessKeys service method on
AmazonIdentityManagementService.
The response from the ListAccessKeys service method, as
returned by AmazonIdentityManagementService.
Retrieves the login profile for the specified User.
Container for the necessary
parameters to execute the GetLoginProfile service method on
AmazonIdentityManagementService.
The response from the GetLoginProfile service method, as
returned by AmazonIdentityManagementService.
Lists the groups the specified User belongs to. You
can paginate the results using the MaxItems and Marker
parameters.
Container for the necessary
parameters to execute the ListGroupsForUser service method on
AmazonIdentityManagementService.
The response from the ListGroupsForUser service method, as
returned by AmazonIdentityManagementService.
Creates a new group. For information about the
number of groups you can create, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
Container for the necessary
parameters to execute the CreateGroup service method on
AmazonIdentityManagementService.
The response from the CreateGroup service method, as returned
by AmazonIdentityManagementService.
Uploads a server certificate entity for the AWS Account. The
server certificate entity includes a public key certificate, a private
key, and an optional certificate chain, which should all be
PEM-encoded. For information about the number of server
certificates you can upload, see Limitations on IAM Entities in
Using AWS Identity and Access Management .
NOTE:Because the body of the public key certificate,
private key, and the certificate chain can be large, you should use
POST rather than GET when calling UploadServerCertificate. For more
information, see Making Query Requests in Using AWS Identity and
Access Management.
Container for the
necessary parameters to execute the UploadServerCertificate service
method on AmazonIdentityManagementService.
The response from the UploadServerCertificate service method,
as returned by AmazonIdentityManagementService.
This action creates an alias for your AWS Account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
.
Container for the necessary
parameters to execute the CreateAccountAlias service method on
AmazonIdentityManagementService.
Retrieves the specified policy document for the specified group.
The returned policy is URL-encoded according to RFC 3986. For more
information about RFC 3986, go to
http://www.faqs.org/rfcs/rfc3986.html.
Container for the necessary
parameters to execute the GetGroupPolicy service method on
AmazonIdentityManagementService.
The response from the GetGroupPolicy service method, as
returned by AmazonIdentityManagementService.
Deletes the specified User. The User must not belong to any
groups, have any keys or signing certificates, or have any attached
policies.
Container for the necessary parameters
to execute the DeleteUser service method on
AmazonIdentityManagementService.
Deactivates the specified MFA device and removes it from
association with the User name for which it was originally
enabled.
Container for the necessary
parameters to execute the DeactivateMFADevice service method on
AmazonIdentityManagementService.
Removes the specified User from the specified group.
Container for the necessary
parameters to execute the RemoveUserFromGroup service method on
AmazonIdentityManagementService.
Deletes the specified server certificate.
IMPORTANT:If your Elastic Load Balancing instances are
using a server certificate, deleting the certificate could have
implications for your application. If your Elastic Load Balancing
instances do not detect the deletion of bound certificates, they may
continue to use the certificates. This could cause them to stop
accepting traffic. We recommend that you remove the reference to the
certificate from your Elastic Load Balancing instances before using
this command to delete the certificate.
Container for the
necessary parameters to execute the DeleteServerCertificate service
method on AmazonIdentityManagementService.
Lists the names of the policies associated with the specified
group. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Container for the necessary
parameters to execute the ListGroupPolicies service method on
AmazonIdentityManagementService.
The response from the ListGroupPolicies service method, as
returned by AmazonIdentityManagementService.
Creates a login profile for the specified User, giving the User
the ability to access AWS services such as the AWS Management Console.
For more information about login profiles, see Managing Login
Profiles and MFA Devices in Using AWS Identity and Access
Management .
Container for the necessary
parameters to execute the CreateLoginProfile service method on
AmazonIdentityManagementService.
The response from the CreateLoginProfile service method, as
returned by AmazonIdentityManagementService.
Creates a new AWS Secret Access Key and corresponding AWS Access
Key ID for the specified User. The default status for new keys is
Active . If you do not specify a User name, IAM
determines the User name implicitly based on the AWS Access Key ID
signing the request. Because this action works for access keys under
the AWS Account, you can use this API to manage root credentials even
if the AWS Account has no associated Users. For
information about limits on the number of keys you can create, see
Limitations on IAM Entities in Using AWS Identity and Access
Management . IMPORTANT:To ensure the security
of your AWS Account, the Secret Access Key is accessible only during
key and User creation. You must save the key (for example, in a text
file) if you want to be able to access it again. If a secret key is
lost, you can delete the access keys for the associated User and then
create new keys.
Container for the necessary
parameters to execute the CreateAccessKey service method on
AmazonIdentityManagementService.
The response from the CreateAccessKey service method, as
returned by AmazonIdentityManagementService.
Retrieves information about the specified User, including the
User's path, GUID, and ARN. If you do not specify a User
name, IAM determines the User name implicitly based on the AWS Access
Key ID signing the request.
Container for the necessary parameters to
execute the GetUser service method on
AmazonIdentityManagementService.
The response from the GetUser service method, as returned by
AmazonIdentityManagementService.
Synchronizes the specified MFA device with AWS servers.
Container for the necessary
parameters to execute the ResyncMFADevice service method on
AmazonIdentityManagementService.
Lists the MFA devices associated with the specified User
name. You can paginate the results using the
MaxItems and Marker parameters.
Container for the necessary
parameters to execute the ListMFADevices service method on
AmazonIdentityManagementService.
The response from the ListMFADevices service method, as
returned by AmazonIdentityManagementService.
Changes the status of the specified access key from Active to
Inactive, or vice versa. This action can be used to disable a User's
key as part of a key rotation workflow. If the
UserName field is not specified, the UserName is determined
implicitly based on the AWS Access Key ID used to sign the request.
Because this action works for access keys under the AWS Account, this
API can be used to manage root credentials even if the AWS Account has
no associated Users. For information about rotating keys,
see Managing Keys and Certificates in Using AWS Identity and Access
Management .
Container for the necessary
parameters to execute the UpdateAccessKey service method on
AmazonIdentityManagementService.
Retrieves account level information about account entity usage
and IAM quotas. For information about limitations on IAM
entities, see Limitations on IAM Entities in Using AWS Identity and
Access Management .
Container for the necessary
parameters to execute the GetAccountSummary service method on
AmazonIdentityManagementService.
The response from the GetAccountSummary service method, as
returned by AmazonIdentityManagementService.
Adds the specified User to the specified group.
Container for the necessary
parameters to execute the AddUserToGroup service method on
AmazonIdentityManagementService.
Returns a list of Users that are in the specified group. You can
paginate the results using the MaxItems and Marker
parameters.
Container for the necessary parameters
to execute the GetGroup service method on
AmazonIdentityManagementService.
The response from the GetGroup service method, as returned by
AmazonIdentityManagementService.
Lists the account aliases associated with the account. For
information about using an AWS Account alias, see Using an Alias for
Your AWS Account ID in Using AWS Identity and Access Management
. You can paginate the results using the MaxItems
and Marker parameters.
Container for the necessary
parameters to execute the ListAccountAliases service method on
AmazonIdentityManagementService.
The response from the ListAccountAliases service method, as
returned by AmazonIdentityManagementService.
Deletes the specified group. The group must not contain any
Users or have any attached policies.
Container for the necessary
parameters to execute the DeleteGroup service method on
AmazonIdentityManagementService.
Response Unmarshaller for ModifyInstanceGroups operation
JobFlowDetail Unmarshaller
AmazonElasticMapReduce exception
Constructs a new InternalServerErrorException with the specified error
message.
Describes the error encountered.
Detailed information about an instance group.
Sets the InstanceGroupId property
The value to set for the InstanceGroupId property
this instance
Sets the Name property
The value to set for the Name property
this instance
Sets the Market property
The value to set for the Market property
this instance
Sets the InstanceRole property
The value to set for the InstanceRole property
this instance
Sets the InstanceType property
The value to set for the InstanceType property
this instance
Sets the InstanceRequestCount property
The value to set for the InstanceRequestCount property
this instance
Sets the InstanceRunningCount property
The value to set for the InstanceRunningCount property
this instance
Sets the State property
The value to set for the State property
this instance
Sets the LastStateChangeReason property
The value to set for the LastStateChangeReason property
this instance
Sets the CreationDateTime property
The value to set for the CreationDateTime property
this instance
Sets the StartDateTime property
The value to set for the StartDateTime property
this instance
Sets the ReadyDateTime property
The value to set for the ReadyDateTime property
this instance
Sets the EndDateTime property
The value to set for the EndDateTime property
this instance
Unique identifier for the instance group.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Friendly name for the instance group.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Market type of the Amazon EC2 instances used to create a cluster node.
Constraints:
-
Allowed Values
ON_DEMAND
Instance group role in the cluster
Constraints:
-
Allowed Values
MASTER, CORE, TASK
Amazon EC2 Instance type.
Constraints:
-
Length
1 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Target number of instances to run in the instance group.
Actual count of running instances.
State of instance group.
Constraints:
-
Allowed Values
PROVISIONING, STARTING, RUNNING, SHUTTING_DOWN, TERMINATED, FAILED
Details regarding the state of the instance group.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The date/time the instance group was created.
The date/time the instance group was started.
The date/time the instance group was available to the cluster.
The date/time the instance group was terminated.
SourceSecurityGroup Unmarshaller
LoadBalancerDescription Unmarshaller
Describe Instance Health Request Marshaller
ConfigureHealthCheckResult Unmarshaller
Returns information about the SetLoadBalancerListenerSSLCertificateResult response and response metadata.
Gets and sets the SetLoadBalancerListenerSSLCertificateResult property.
The output for the SetLoadBalancerListenerSSLCertificate action.
The Policies data type.
Default constructor for a new Policies object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Adds elements to the AppCookieStickinessPolicies collection
The values to add to the AppCookieStickinessPolicies collection
this instance
Adds elements to the AppCookieStickinessPolicies collection
The values to add to the AppCookieStickinessPolicies collection
this instance
Adds elements to the LBCookieStickinessPolicies collection
The values to add to the LBCookieStickinessPolicies collection
this instance
Adds elements to the LBCookieStickinessPolicies collection
The values to add to the LBCookieStickinessPolicies collection
this instance
A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
A list of the LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
AmazonElasticLoadBalancing exception
Constructs a new DuplicatePolicyNameException with the specified error
message.
Describes the error encountered.
The output for the DeleteLoadBalancerPolicy action.
Provides a list of validation messages.
Adds elements to the Messages collection
The values to add to the Messages collection
this instance
Adds elements to the Messages collection
The values to add to the Messages collection
this instance
A list of ValidationMessage.
Returns information about the ValidateConfigurationSettingsResult response and response metadata.
Gets and sets the ValidateConfigurationSettingsResult property.
Provides a list of validation messages.
Describes the properties of an environment.
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EndpointURL property
The value to set for the EndpointURL property
this instance
Sets the CNAME property
The value to set for the CNAME property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the Health property
The value to set for the Health property
this instance
Sets the Resources property
The value to set for the Resources property
this instance
The name of this environment.
Constraints:
-
Length
4 - 23
The ID of this environment.
The name of the application associated with this environment.
Constraints:
-
Length
1 - 100
The application version deployed in this environment.
Constraints:
-
Length
1 - 100
The name of the SolutionStack deployed with this environment.
Constraints:
-
Length
0 - 100
The name of the configuration template used to originally launch this environment.
Constraints:
-
Length
1 - 100
Describes this environment.
Constraints:
-
Length
0 - 200
The URL to the LoadBalancer for this environment.
The URL to the CNAME for this environment.
Constraints:
-
Length
1 - 255
The creation date for this environment.
The last modified date for this environment.
The current operational status of the environment: - Launching: Environment is in the process of initial deployment.
- Updating: Environment is in the process of updating its configuration settings or application version.
- Ready:
Environment is available to have an action performed on it, such as update or terminate.
- Terminating: Environment is in
the shut-down process.
- Terminated: Environment is not running.
Constraints:
-
Allowed Values
Launching, Updating, Ready, Terminating, Terminated
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working. Yellow: Indicates that
something is wrong, the application might not be available, but the instances appear running. Green:
Indicates the environment is healthy and fully functional. - Red: Indicates the environment is not
responsive. Occurs when three or more consecutive failures occur for an environment.
- Yellow: Indicates that something is
wrong. Occurs when two consecutive failures occur for an environment.
- Green: Indicates the environment is healthy and
fully functional.
- Grey: Default health for a new environment. The environment is not fully launched and health checks have
not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default:
Grey
Constraints:
-
Allowed Values
Green, Yellow, Red, Grey
The description of the AWS resources used by this environment.
Result message containing a single description of an application.
Sets the Application property
The value to set for the Application property
this instance
The ApplicationDescription of the application.
Returns information about the UpdateApplicationResult response and response metadata.
Gets and sets the UpdateApplicationResult property.
Result message containing a single description of an application.
Validate Configuration Settings Request Marshaller
List Available Solution Stacks Request Marshaller
DescribeEventsResult Unmarshaller
DescribeConfigurationSettingsResult Unmarshaller
Create Application Request Marshaller
AmazonElasticBeanstalk exception
Constructs a new TooManyApplicationVersionsException with the specified error
message.
Describes the error encountered.
A specification for an environment configuration
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
The name of the application associated with the configuration.
Constraints:
-
Length
1 - 100
The name of the configuration template.
Constraints:
-
Length
1 - 100
Container for the parameters to the RestartAppServer operation.
Causes the environment to restart the application container server running on each Amazon EC2 instance.
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
The ID of the environment to restart the server for.
The name of the environment to restart the server for.
Constraints:
-
Length
4 - 23
Returns information about the RequestEnvironmentInfo response metadata.
The RequestEnvironmentInfo operation has a void result type.
The information retrieved from the Amazon EC2 instances.
Sets the InfoType property
The value to set for the InfoType property
this instance
Sets the Ec2InstanceId property
The value to set for the Ec2InstanceId property
this instance
Sets the SampleTimestamp property
The value to set for the SampleTimestamp property
this instance
Sets the Message property
The value to set for the Message property
this instance
The type of information retrieved.
Constraints:
-
Allowed Values
tail
The Amazon EC2 Instance ID for this information.
The time stamp when this information was retrieved.
The retrieved information.
Container for the parameters to the DescribeApplications operation.
Returns the descriptions of existing applications.
Adds elements to the ApplicationNames collection
The values to add to the ApplicationNames collection
this instance
Adds elements to the ApplicationNames collection
The values to add to the ApplicationNames collection
this instance
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
Returns information about the DeleteApplicationVersion response metadata.
The DeleteApplicationVersion operation has a void result type.
Properties of a Launched EC2 Instance
Sets the InstanceId property
Unique ID of the instance launched.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the ImageId property
Image ID of the AMI used to launch the
instance.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the InstanceState property
The current state of the instance.
this instance
Checks if InstanceState property is set
true if InstanceState property is set
Sets the PrivateDnsName property
The private DNS name assigned to the instance.
This DNS name can only be used inside the Amazon EC2 network.
This element remains empty until the instance
enters a running state
this instance
Checks if PrivateDnsName property is set
true if PrivateDnsName property is set
Sets the PublicDnsName property
The public DNS name assigned to the instance.
This DNS name is contactable from
outside the Amazon EC2 network.
This element remains empty until the
instance enters a running state
this instance
Checks if PublicDnsName property is set
true if PublicDnsName property is set
Sets the StateTransitionReason property
Reason for the most recent state transition.
This might be an empty string.
this instance
Checks if StateTransitionReason property is set
true if StateTransitionReason property is set
Sets the KeyName property
If this instance was launched with an
associated key pair, this
displays the key pair
name.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the AmiLaunchIndex property
The AMI launch index, which can be used to find
this instance
within the launch
group.
this instance
Checks if AmiLaunchIndex property is set
true if AmiLaunchIndex property is set
Sets the ProductCode property
Product codes attached to this instance.
this instance
Checks if ProductCode property is set
true if ProductCode property is set
Sets the InstanceType property
The instance type.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the LaunchTime property
The time the instance launched.
this instance
Checks if LaunchTime property is set
true if LaunchTime property is set
Sets the Placement property
The location where the instance launched.
this instance
Checks if Placement property is set
true if Placement property is set
Sets the KernelId property
Kernel associated with this instance.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
RAM disk associated with this instance.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the Platform property
Platform of the instance (e.g., Windows).
this instance
Checks if Platform property is set
true if Platform property is set
Sets the Monitoring property
Specifies whether monitoring is enabled for the
instance.
this instance
Checks if Monitoring property is set
true if Monitoring property is set
Sets the SubnetId property
Specifies the subnet ID in which the instance
is running (Amazon Virtual Private Cloud).
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the VpcId property
Specifies the VPC in which the instance is
running (Amazon Virtual Private Cloud).
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the PrivateIpAddress property
Specifies the private IP address that is
assigned to the instance (Amazon VPC).
this instance
Checks if PrivateIpAddress property is set
true if PrivateIpAddress property is set
Sets the IpAddress property
Specifies the IP address of the instance.
this instance
Checks if IpAddress property is set
true if IpAddress property is set
Sets the SourceDestCheck property
This attribute exists to enable a Network Address Translation (NAT)
instance in a VPC to perform NAT. The attribute controls whether
source/destination checking is enabled on the instance. A value of
true means checking is enabled, and false means checking is
disabled. The value must be false for the instance to perform NAT.
For more information, go to NAT Instances in the Amazon Virtual
Private Cloud User Guide.
this instance
Checks if SourceDestCheck property is set
true if SourceDestCheck property is set
Sets the GroupId property
A list of VPC security groups the instance is in.
this instance
Checks if GroupId property is set
true if GroupId property is set
Sets the GroupName property
A list of security groups the instance is in.
this instance
Checks if GroupName property is set
true if GroupId property is set
Sets the StateReason property
The reason for the state change.
this instance
Checks if StateReason property is set
true if StateReason property is set
Sets the Architecture property
The architecture of the image.
this instance
Checks if Architecture property is set
true if Architecture property is set
Sets the RootDeviceType property
The root device type used by the AMI. The AMI
can use an Amazon EBS or instance store root device.
this instance
Checks if RootDeviceType property is set
true if RootDeviceType property is set
Sets the RootDeviceName property
The root device name (e.g., /dev/sda1).
this instance
Checks if RootDeviceName property is set
true if RootDeviceName property is set
Sets the BlockDeviceMapping property
Block device mapping set.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Sets the InstanceLifecycle property
InstanceLifecycle property
this instance
Checks if InstanceLifecycle property is set
true if InstanceLifecycle property is set
Sets the SpotInstanceRequestId property
The ID of the Spot Instance request that
started this instance.
this instance
Checks if SpotInstanceRequestId property is set
true if SpotInstanceRequestId property is set
Sets the License property
The active license in use and attached to the
Amazon EC2 instance.
this instance
Checks if License property is set
true if License property is set
Sets the VirtualizationType property
Specifies whether the Amazon EC2 instance is a
hardware virtual machine
(HVM) or a para-virtual machine (PVM).
this instance
Checks if VirtualizationType property is set
true if VirtualizationType property is set
Sets the ClientToken property
ClientToken property
this instance
Checks if ClientToken property is set
true if ClientToken property is set
Sets the Tag property
A list of tags for the RunningInstance.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the InstanceId property.
Unique ID of the instance launched.
Gets and sets the ImageId property.
Image ID of the AMI used to launch the
instance.
Gets and sets the InstanceState property.
The current state of the instance.
Gets and sets the PrivateDnsName property.
The private DNS name assigned to the instance.
This DNS name can only be used inside the Amazon EC2 network.
This element remains empty until the instance
enters a running state
Gets and sets the PublicDnsName property.
The public DNS name assigned to the instance.
This DNS name is contactable from
outside the Amazon EC2 network.
This element remains empty until the
instance enters a running state
Gets and sets the StateTransitionReason property.
Reason for the most recent state transition.
This might be an empty string.
Gets and sets the KeyName property.
If this instance was launched with an
associated key pair, this
displays the key pair
name.
Gets and sets the AmiLaunchIndex property.
The AMI launch index, which can be used to find
this instance
within the launch
group.
Gets and sets the ProductCode property.
Product codes attached to this instance.
Gets and sets the InstanceType property.
The instance type.
Gets and sets the LaunchTime property.
The time the instance launched.
Gets and sets the Placement property.
The location where the instance launched.
Gets and sets the KernelId property.
Kernel associated with this instance.
Gets and sets the RamdiskId property.
RAM disk associated with this instance.
Gets and sets the Platform property.
Platform of the instance (e.g., Windows).
Gets and sets the Monitoring property.
Specifies whether monitoring is enabled for the
instance.
Gets and sets the SubnetId property.
Specifies the subnet ID in which the instance
is running (Amazon Virtual Private Cloud).
Gets and sets the VpcId property.
Specifies the VPC in which the instance is
running (Amazon Virtual Private Cloud).
Gets and sets the PrivateIpAddress property.
Specifies the private IP address that is
assigned to the instance (Amazon VPC).
Gets and sets the IpAddress property.
Specifies the IP address of the instance.
Gets and sets the SourceDestCheck property.
This attribute exists to enable a Network Address Translation (NAT)
instance in a VPC to perform NAT. The attribute controls whether
source/destination checking is enabled on the instance. A value of
true means checking is enabled, and false means checking is
disabled. The value must be false for the instance to perform NAT.
For more information, go to NAT Instances in the Amazon Virtual
Private Cloud User Guide.
Gets and sets the GroupId property.
A list of VPC security groups the instance is in.
Gets and sets the GroupName property.
A list of security groups the instance is in.
Gets and sets the StateReason property.
The reason for the state change.
Gets and sets the Architecture property.
The architecture of the image.
Gets and sets the RootDeviceType property.
The root device type used by the AMI. The AMI
can use an Amazon EBS or instance store root device.
Gets and sets the RootDeviceName property.
The root device name (e.g., /dev/sda1).
Gets and sets the BlockDeviceMapping property.
Block device mapping set.
Gets and sets the InstanceLifecycle property.
Gets and sets the SpotInstanceRequestId property.
The ID of the Spot Instance request that
started this instance.
Gets and sets the License property.
The active license in use and attached to the
Amazon EC2 instance.
Gets and sets the VirtualizationType property.
Specifies whether the Amazon EC2 instance is a
hardware virtual machine
(HVM) or a para-virtual machine (PVM).
Gets and sets the ClientToken property.
Gets and sets the Tag property.
A list of tags for the RunningInstance.
Replaces an existing route within a route table in a VPC. For more information about route tables, go to
Route Tables in the Amazon Virtual Private Cloud User Guide.
Sets the RouteTableId property
The ID of the route table where the route will
be replaced.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the DestinationCidrBlock property
The CIDR address block used for the
destination match. For example: 0.0.0.0/0.The
value you provide must match the CIDR of an
existing route in the table.
this instance
Checks if DestinationCidrBlock property is set
true if DestinationCidrBlock property is set
Sets the GatewayId property
The ID of a gateway attached to your VPC.
this instance
Checks if GatewayId property is set
true if GatewayId property is set
Sets the InstanceId property
The ID of a NAT instance in your VPC.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the RouteTableId property.
The ID of the route table where the route will
be replaced.
Gets and sets the DestinationCidrBlock property.
The CIDR address block used for the
destination match. For example: 0.0.0.0/0.The
value you provide must match the CIDR of an
existing route in the table.
Gets and sets the GatewayId property.
The ID of a gateway attached to your VPC.
Gets and sets the InstanceId property.
The ID of a NAT instance in your VPC.
Register Image Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if RegisterImageResult property is set
true if RegisterImageResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the RegisterImageResult property.
Register Image Result
Enables monitoring for a running instance. For
more information, refer to
the Amazon CloudWatch Developer Guide.
Sets the InstanceId property
Instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
Instance ID.
Modifies an attribute of an AMI
Sets the ImageId property
The AMI ID.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the Attribute property
Specifies the attribute to modify. Valid
Values: launchPermission |
productCodes
this instance
Checks if Attribute property is set
true if Attribute property is set
Sets the OperationType property
Specifies the operation to perform on the
attribute. Valid Values: add | remove
this instance
Checks if OperationType property is set
true if OperationType property is set
Sets the UserId property
AWS Access Key ID.
this instance
Checks if UserId property is set
true if UserId property is set
Sets the UserGroup property
Name of the group. Currently supports "all."
this instance
Checks if UserGroup property is set
true if UserGroup property is set
Sets the ProductCode property
Product code.
this instance
Checks if ProductCode property is set
true if ProductCode property is set
Sets the Description property
Description property
this instance
Checks if Description property is set
true if Description property is set
Gets and sets the ImageId property.
The AMI ID.
Gets and sets the Attribute property.
Specifies the attribute to modify. Valid
Values: launchPermission |
productCodes
Gets and sets the OperationType property.
Specifies the operation to perform on the
attribute. Valid Values: add | remove
Gets and sets the UserId property.
AWS Access Key ID.
Gets and sets the UserGroup property.
Name of the group. Currently supports "all."
Gets and sets the ProductCode property.
Product code.
Gets and sets the Description property.
Instance Monitoring
Sets the InstanceId property
Instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Monitoring property
State of monitoring for the instance. Valid
Values:
monitoring-enabled (enabled)
| monitoring-pending
(pending) | monitoring-disabled (disabled)
this instance
Checks if Monitoring property is set
true if Monitoring property is set
Gets and sets the InstanceId property.
Instance ID.
Gets and sets the Monitoring property.
State of monitoring for the instance. Valid
Values:
monitoring-enabled (enabled)
| monitoring-pending
(pending) | monitoring-disabled (disabled)
Image Attribute
Sets the ImageId property
The ID of the AMI.
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the LaunchPermission property
Launch permissions.
this instance
Checks if LaunchPermission property is set
true if LaunchPermission property is set
Sets the ProductCode property
Product codes.
this instance
Checks if ProductCode property is set
true if ProductCode property is set
Sets the KernelId property
Kernel ID.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
RAM disk ID.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the Description property
Description property
this instance
Checks if Description property is set
true if Description property is set
Sets the BlockDeviceMapping property
Block device mapping.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Gets and sets the ImageId property.
The ID of the AMI.
Gets and sets the LaunchPermission property.
Launch permissions.
Gets and sets the ProductCode property.
Product codes.
Gets and sets the KernelId property.
Kernel ID.
Gets and sets the RamdiskId property.
RAM disk ID.
Gets and sets the Description property.
Gets and sets the BlockDeviceMapping property.
Block device mapping.
Gives you information about your VPCs. You can filter the results to
return information only about VPCs that match criteria you specify.
For example, you could ask to get information about a particular VPC
or VPCs (or all your VPCs) only if the VPC's state is available.
You can specify multiple filters (e.g., the VPC uses one of several
sets of DHCP options, and the VPC's state is available).
The result includes information for a particular VPC only if the VPC matches all your filters.
If there's no match, no special message is returned; the response is simply empty.
The information returned consists of:
a) The VPC ID.
b) The CIDR block
you've assigned to the VPC.
c) The ID of the DHCP options you've associated with the VPC
(or "default" if the default options are associated with the VPC)
The current state of the VPC (pending or available)
Sets the VpcId property
The ID of a VPC you want information about.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the Filter property
The available filters are:
1. state - The state of the VPC. Valid Values: pending,
available.
2. cidrBlock - The CIDR block of the VPC. The CIDR block you
specify must exactly match the VPC's CIDR block for information to be
returned for the VPC.
Constraints: Must contain the slash followed by one or two
digits (e.g., /28).
3. dhcpOptionsId - The IP of a set of DHCP options.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the VpcId property.
The ID of a VPC you want information about.
Gets and sets the Filter property.
The available filters are:
1. state - The state of the VPC. Valid Values: pending,
available.
2. cidrBlock - The CIDR block of the VPC. The CIDR block you
specify must exactly match the VPC's CIDR block for information to be
returned for the VPC.
Constraints: Must contain the slash followed by one or two
digits (e.g., /28).
3. dhcpOptionsId - The IP of a set of DHCP options.
Describes Tags for the specified resources.
Sets the Filter property
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the Filter property.
A list of filters used to match system-defined properties associated with the specified
Tags.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Describe Subnets Result
Checks if Subnet property is set
true if Subnet property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Subnet property.
List of subnets
The Response for the
DescribeSpotDatafeedSubscription operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSpotDatafeedSubscriptionResult property is set
true if DescribeSpotDatafeedSubscriptionResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSpotDatafeedSubscriptionResult property.
Describe Spot Datafeed Result
Information returned by a
DescribeInstanceAttribute request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeInstanceAttributeResult property is set
true if DescribeInstanceAttributeResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeInstanceAttributeResult property.
Information about the instance attribute.
Returns information about an attribute of an
instance. Only one attribute
can be specified per call.
Sets the InstanceId property
Instance IDs to describe.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Attribute property
Specifies the attribute to return. Values are
"instanceType", "kernel", "ramdisk", "userData",
"disableApiTermination", "instanceInitiatedShutdownBehavior",
"sourceDestCheck", "groupSet",
"rootDeviceName", and "blockDeviceMapping"
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the InstanceId property.
Instance IDs to describe.
Gets and sets the Attribute property.
Specifies the attribute to return. Values are
"instanceType", "kernel", "ramdisk", "userData",
"disableApiTermination", "instanceInitiatedShutdownBehavior",
"sourceDestCheck", "groupSet",
"rootDeviceName", and "blockDeviceMapping"
Describe Images Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeImagesResult property is set
true if DescribeImagesResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeImagesResult property.
Describe Images Result
Describe Addresses Result
Checks if Address property is set
true if Address property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Address property.
The list of IP addresses.
The Response for the
DeleteRouteTableResponse operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Subnet Result
Checks if Subnet property is set
true if Subnet property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Subnet property.
Subnet
Allocate Address Result
Checks if Domain property is set
true if Domain property is set
Checks if AllocationId property is set
true if AllocationId property is set
Checks if PublicIp property is set
true if PublicIp property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Domain property.
Whether this elastic IP address is for instances in EC2 (i.e., standard)
or instances in a VPC.
Gets and sets the AllocationId property.
ID that AWS assigns to represent the allocation of the address for
use with Amazon VPC. Returned only for VPC elastic IP addresses.
Gets and sets the PublicIp property.
IP address for use with your account.
A static public IP address designed for dynamic
cloud computing. Any elastic IP addresses that you associate with
your account remains associated with your account until you
explicitly release them. Unlike traditional static IP
addresses, however, elastic IP addresses allow you to mask instance or
Availability Zone failures by rapidly remapping your public IP
addresses to any instance in your account. The Address type contains
an Elastic IP associated with your account
and the InstanceId of the instance it is associated with.
Sets the InstanceId property
The ID of the instance.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the PublicIp property
The public IP address.
this instance
Checks if PublicIp property is set
true if PublicIp property is set
Sets the AllocationId property
The ID representing the allocation of the address for use with Amazon
VPC
this instance
Checks if AllocationId property is set
true if AllocationId property is set
Sets the AssociationId property
The ID representing the association of a VPC elastic IP address with
an instance in a VPC.
this instance
Checks if AssociationId property is set
true if AssociationId property is set
Sets the Domain property
Whether this elastic IP address is for instances in EC2 (i.e., standard)
or Amazon VPC.
this instance
Checks if Domain property is set
true if Domain property is set
Gets and sets the InstanceId property.
The ID of the instance.
Gets and sets the PublicIp property.
The public IP address.
Gets and sets the AllocationId property.
The ID representing the allocation of the address for use with Amazon
VPC
Gets and sets the AssociationId property.
The ID representing the association of a VPC elastic IP address with
an instance in a VPC.
Gets and sets the Domain property.
Whether this elastic IP address is for instances in EC2 (i.e., standard)
or Amazon VPC.
Dimension Unmarshaller
Response Unmarshaller for DeleteAlarms operation
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 GetMetricStatistics 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 NextToken values with subsequent ListMetrics
operations. NOTE: If you create a metric with the
PutMetricData action, allow up to fifteen minutes for the metric to
appear in calls to the ListMetrics action.
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the MetricName property
The value to set for the MetricName property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The namespace to filter against.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The name of the metric to filter against.
Constraints:
-
Length
1 - 255
A list of dimensions to filter against.
Constraints:
-
Length
0 - 10
The token returned by a previous call to indicate that there is more data available.
Returns information about the DescribeAlarmsForMetricResult response and response metadata.
Gets and sets the DescribeAlarmsForMetricResult property.
The output for the DescribeAlarmsForMetric action.
The ListDistributionsResponse contains the ListDistributionsResult and
any headers or metadata returned by CloudFront.
Gets the Distribution property as a List
Gets and sets the Marker property.
Gets and sets the MaxItems property.
Gets and sets the NextMarker property.
Gets and sets the IsTruncated property.
The GetInvalidationListResponse contains the list of invalidations done on a particular distribution
and any headers returned by CloudFront.
Gets and Sets the Marker property.
Gets and Sets the NextMarker property. If IsTruncated is true, this element is present and
contains the value you can use for the Marker
request parameter to continue listing your
invalidations where they left off.
Gets and Sets the MaxItems property.
Gets and Sets the IsTruncated property which indicated whether all the data was returned from Cloudfront.
If the value is true the NextMarker property can be used on another request to get the next page of data.
Gets and Sets the Summaries property.
ListStacksResult Unmarshaller
List Stacks Request Marshaller
Response Unmarshaller for DescribeStacks operation
Container for the parameters to the GetTemplate operation.
Returns the template body for a specified stack name. You can get the template for running or deleted stacks. For deleted
stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. NOTE: If the template does
not exist, a ValidationError is returned.
Sets the StackName property
The value to set for the StackName property
this instance
The name or the unique identifier associated with the stack.
Response Unmarshaller for ExecutePolicy operation
Response Unmarshaller for DescribeMetricCollectionTypes operation
Describe Auto Scaling Instances Request Marshaller
Delete Notification Configuration Request Marshaller
Container for the parameters to the SetDesiredCapacity operation.
Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not
possible to define which EC2 instances will be terminated. This applies to any auto-scaling decisions that might result in terminating
instances. There are two common use cases for SetDesiredCapacity :
one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use
cases relate to the concept of cooldown. In the first case, if you use the Auto Scaling triggering system,
SetDesiredCapacity changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for
example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject
requests to change the size of the group for that entire 10 minute period. The SetDesiredCapacity command allows you to circumvent
this restriction and change the size of the group before the end of the cooldown period. In the second case, if you write
your own triggering system, you can use SetDesiredCapacity to control the size of your Auto Scaling group. If you want the same
cooldown functionality that Auto Scaling offers, you can configure SetDesiredCapacity to honor cooldown by setting the
HonorCooldown parameter to true .
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
Sets the HonorCooldown property
The value to set for the HonorCooldown property
this instance
The name of the AutoScalingGroup.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The new capacity setting for the AutoScalingGroup.
By default, SetDesiredCapacity overrides any cooldown period. Set to True if you want Auto Scaling to reject this request if the Auto
Scaling group is in cooldown.
Returns information about the EnableMetricsCollection response metadata.
The EnableMetricsCollection operation has a void result type.
The output for the DescribeScalingActivities action.
Adds elements to the Activities collection
The values to add to the Activities collection
this instance
Adds elements to the Activities collection
The values to add to the Activities collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of the requested scaling activities.
Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass
this in to subsequent calls to return additional results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns information about the DescribeLaunchConfigurationsResult response and response metadata.
Gets and sets the DescribeLaunchConfigurationsResult property.
The LaunchConfigurationsType data type.
Returns information about the DescribeAutoScalingNotificationTypesResult response and response metadata.
Gets and sets the DescribeAutoScalingNotificationTypesResult property.
Container for the parameters to the DeleteLaunchConfiguration operation.
Deletes the specified LaunchConfiguration. The specified launch configuration must not be attached to an Auto Scaling
group. Once this call completes, the launch configuration is no longer available for use.
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
The name of the launch configuration.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Container for the parameters to the CreateAutoScalingGroup operation.
Creates a new Auto Scaling group with the specified name. Once the creation request is completed, the AutoScalingGroup is ready to be
used in other calls. NOTE: The Auto Scaling group name must be unique within the scope of your AWS account, and under
the quota of Auto Scaling groups allowed for your account.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Sets the MinSize property
The value to set for the MinSize property
this instance
Sets the MaxSize property
The value to set for the MaxSize property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
Sets the DefaultCooldown property
The value to set for the DefaultCooldown property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
Adds elements to the LoadBalancerNames collection
The values to add to the LoadBalancerNames collection
this instance
Sets the HealthCheckType property
The value to set for the HealthCheckType property
this instance
Sets the HealthCheckGracePeriod property
The value to set for the HealthCheckGracePeriod property
this instance
Sets the PlacementGroup property
The value to set for the PlacementGroup property
this instance
Sets the VPCZoneIdentifier property
The value to set for the VPCZoneIdentifier property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the launch configuration to use with the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The minimum size of the Auto Scaling group.
The maximum size of the Auto Scaling group.
The number of EC2 instances that should be running in the group.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
A list of availability zones for the Auto Scaling group.
Constraints:
-
Length
1 -
A list of LoadBalancers to use.
The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are "EC2" or "ELB."
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.
Physical location of your cluster placement group created in Amazon EC2.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The subnet identifier of the Virtual Private Cloud.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Configuration for accessing Auto Scaling service
Default constructor
Gets the ServiceVersion property.
The available AWS access control policy actions for Amazon S3.
Represents any action being taken on Amazon S3.
Action for retrieving an object (GET), object metadata (HEAD) or an object torrent.
Valid for use with resources.
Action for retrieving a object version (GET), object metadata for an
object version (HEAD) or a torrent for an object version.
Valid for use with resources.
Action for uploading an object (PUT or POST).
Valid for use with resources.
Action for retrieving an object's ACL.
Valid for use with resources.
Action for retrieving an object version's ACL.
Valid for use with resources.
Action for setting an object's ACL.
Valid for use with resources.
Action for setting an object version's ACL.
Valid for use with resources.
Action for deleting an object.
Valid for use with resources.
Action for deleting an object version.
Valid for use with resources.
Action for creating a new Amazon S3 bucket.
Valid for use with resources.
Action for deleting an Amazon S3 bucket.
Valid for use with resources.
Action for listing the objects in an Amazon S3 bucket.
Valid for use with resources.
Action for listing the object versions in an Amazon S3 bucket.
Valid for use with resources.
Action for listing the Amazon S3 buckets in an account.
Valid for use with resources.
Action for retrieving the ACL of an Amazon S3 bucket.
Valid for use with resources.
Action for setting the ACL of an Amazon S3 bucket.
Valid for use with resources.
Action for retrieving the versioning configuration of an Amazon S3 bucket.
Valid for use with resources.
Action for setting the versioning configuration of an Amazon S3 bucket.
Valid for use with resources.
Action for retrieving the requester pays status of an Amazon S3 bucket.
Valid for use with resources.
Action for setting the requester pays status of an Amazon S3 bucket.
Valid for use with resources.
Action for retrieving the bucket location of an Amazon S3 bucket.
Valid for use with resources.
Action for retrieving the access control policy for an Amazon S3 bucket.
Valid for use with resources.
Action for setting the access control policy for an Amazon S3 bucket.
Valid for use with resources.
Action for retrieving the bucket notification configuration for an Amazon
S3 bucket.
Valid for use with resources.
Action for setting the bucket notification configuration for an Amazon S3
bucket.
Valid for use with resources.
Returns information about the message, including an MD5 of the message body, message ID, and request metadata.
Checks if SendMessageResult property is set
true if SendMessageResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SendMessageResult property.
Information about the message sent to Amazon SQS.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Gets one or all attributes of a queue.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the AttributeName property
The attribute you want to get. Values can be:
All | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | VisibilityTimeout | CreatedTimestamp | LastModifiedTimestamp | Policy
this instance
Checks if AttributeName property is set
true if AttributeName property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the AttributeName property.
The attribute you want to get. Values can be:
All | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | VisibilityTimeout | CreatedTimestamp | LastModifiedTimestamp | Policy
Returns metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
The CreateQueue action creates a new queue, or returns the URL of an existing one.
When you request CreateQueue, you provide a name for the queue. To successfully
create a new queue, you must provide a name that is unique within the scope of
your own queues. If you provide the name of an existing queue, a new queue isn't
created and an error isn't returned. Instead, the request succeeds and the queue
URL for the existing queue is returned. Exception: if you provide a value for
DefaultVisibilityTimeout that is different from the value for the existing queue,
you receive an error.
Sets the QueueName property
The name to use for the queue created. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
this instance
Checks if QueueName property is set
true if QueueName property is set
Sets the DefaultVisibilityTimeout property
The visibility timeout (in seconds) to use for this queue. Values can be 0 to 43200 (maximum 12 hours). Default is 30 seconds.
this instance
Checks if DefaultVisibilityTimeout property is set
true if DefaultVisibilityTimeout property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueName property.
The name to use for the queue created. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
Gets and sets the DefaultVisibilityTimeout property.
The visibility timeout (in seconds) to use for this queue. Values can be 0 to 43200 (maximum 12 hours). Default is 30 seconds.
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
The ChangeMessageVisibility action extends the read lock timeout of the specified message
from the specified queue to the specified value.
Sets the QueueUrl property
The URL associated with the Amazon SQS queue.
this instance
Checks if QueueUrl property is set
true if QueueUrl property is set
Sets the ReceiptHandle property
The receipt handle associated with the message whose visibility timeout you want to change.
This parameter is returned by the ReceiveMessage action.
this instance
Checks if ReceiptHandle property is set
true if ReceiptHandle property is set
Sets the VisibilityTimeout property
The new value for the message's visibility timeout (in seconds).
this instance
Checks if VisibilityTimeout property is set
true if VisibilityTimeout property is set
Sets the Attribute property
Name and value pair of an attribute associated with the queue.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the QueueUrl property.
The URL associated with the Amazon SQS queue.
Gets and sets the ReceiptHandle property.
The receipt handle associated with the message whose visibility timeout you want to change.
This parameter is returned by the ReceiveMessage action.
Gets and sets the VisibilityTimeout property.
The new value for the message's visibility timeout (in seconds).
Gets and sets the Attribute property.
Name and value pair of an attribute associated with the queue.
The Publish action sends a message to all of a topic's subscribed endpoints. When a
messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it
to the topic's subscribers shortly. The format of the outgoing message to each
subscribed endpoint depends on the notification protocol selected.
Sets the TopicArn property
The topic you want to publish to.
this instance
Checks if TopicArn property is set
true if TopicArn property is set
Sets the Message property
The message you want to send to the topic.
this instance
Checks if Message property is set
true if Message property is set
Sets the Subject property
Optional parameter to be used as the "Subject" line of when the message is
delivered to e-mail endpoints. This field will also be included, if present,
in the standard JSON messages delivered to other endpoints.
this instance
Checks if Subject property is set
true if Subject property is set
Gets and sets the TopicArn property.
The topic you want to publish to.
Gets and sets the Message property.
The message you want to send to the topic.
Gets and sets the Subject property.
Optional parameter to be used as the "Subject" line of when the message is
delivered to e-mail endpoints. This field will also be included, if present,
in the standard JSON messages delivered to other endpoints.
The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics. If
there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get
further results.
Sets the NextToken property
Token returned by the previous ListTopics request.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the NextToken property.
Token returned by the previous ListTopics request.
Encapsulates the metadata and result of the ListSubscriptions action.
Checks if ListSubscriptionsResult property is set
true if ListSubscriptionsResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ListSubscriptionsResult property.
Encapsulates the result of the ListSubscriptions action.
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a
new ListSubscriptions call to get further results.
Sets the NextToken property
Token returned by the previous ListSubscriptions request.
this instance
Checks if NextToken property is set
true if NextToken property is set
Gets and sets the NextToken property.
Token returned by the previous ListSubscriptions request.
AmazonSimpleNotificationServiceClient is an implementation of AmazonSimpleNotificationService;
the client allows you to manage your AmazonSimpleNotificationService resources.
If you want to use the AmazonSimpleNotificationServiceClient from a Medium Trust
hosting environment, please create the client with an
AmazonSimpleNotificationServiceConfig object whose UseSecureStringForAwsSecretKey
property is false.
Amazon Simple Notification Service
Implements the Dispose pattern for the AmazonSimpleNotificationServiceClient
Whether this object is being disposed via a call to Dispose
or garbage collected.
Disposes of all managed and unmanaged resources.
The destructor for the client class.
Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key
AWS Access Key ID
AWS Secret Access Key
Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an
AmazonSimpleNotificationService Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
AWS Access Key ID
AWS Secret Access Key
The AmazonSimpleNotificationService Configuration Object
Constructs an AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an
AmazonSimpleNotificationService Configuration object
AWS Access Key ID
AWS Secret Access Key as a SecureString
The AmazonSimpleNotificationService Configuration Object
Confirm Subscription
Confirm Subscription request
Confirm Subscription Response from the service
The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe action. If the
token is valid, the action creates a new subscription and returns its
Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".
Get Topic Attributes
Get Topic Attributes request
Get Topic Attributes Response from the service
The GetTopicAttribtues action returns all of the properties of a topic customers have created. Topic
properties returned might differ based on the authorization of the user.
Subscribe
Subscribe request
Subscribe Response from the service
The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are
valid for twenty-four hours.
Set Topic Attributes
Set Topic Attributes request
Set Topic Attributes Response from the service
The SetTopicAttributes action allows a topic owner to set an attribute of the topic to a new value.
Delete Topic
Delete Topic request
Delete Topic Response from the service
The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might
prevent some messages previously sent to the topic from being delivered to
subscribers. This action is idempotent, so deleting a topic that does not
exist will not result in an error.
Remove Permission
Remove Permission request
Remove Permission Response from the service
The RemovePermission action removes a statement from a topic's access control policy.
List Subscriptions
List Subscriptions request
List Subscriptions Response from the service
The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a
new ListSubscriptions call to get further results.
Add Permission
Add Permission request
Add Permission Response from the service
The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Create Topic
Create Topic request
Create Topic Response from the service
The CreateTopic action creates a topic to which notifications can be published. Users can create
at most 25 topics. This action is idempotent, so if the requester
already owns a topic with the specified name, that topic's ARN will be
returned without creating a new topic.
List Topics
List Topics request
List Topics Response from the service
The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics. If
there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get
further results.
Unsubscribe
Unsubscribe request
Unsubscribe Response from the service
The Unsubscribe action deletes a subscription. If the subscription requires authentication for
deletion, only the owner of the subscription or the its topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester is not
the subscription owner, a final cancellation message is delivered to the
endpoint, so that the endpoint owner can easily resubscribe to the topic if
the Unsubscribe request was unintended.
List Subscriptions By Topic
List Subscriptions By Topic request
List Subscriptions By Topic Response from the service
The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns
a limited list of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
Publish
Publish request
Publish Response from the service
The Publish action sends a message to all of a topic's subscribed endpoints. When a
messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it
to the topic's subscribers shortly. The format of the outgoing message to each
subscribed endpoint depends on the notification protocol selected.
Configure HttpClient with set of defaults as well as configuration
from AmazonSimpleNotificationServiceConfig instance
Invoke request and return response
Look for additional error strings in the response and return formatted exception
Exponential sleep on failed request
Add authentication related and version parameters
Convert ConfirmSubscriptionRequest to name value pairs
Convert GetTopicAttributesRequest to name value pairs
Convert SubscribeRequest to name value pairs
Convert SetTopicAttributesRequest to name value pairs
Convert DeleteTopicRequest to name value pairs
Convert RemovePermissionRequest to name value pairs
Convert ListSubscriptionsRequest to name value pairs
Convert AddPermissionRequest to name value pairs
Convert CreateTopicRequest to name value pairs
Convert ListTopicsRequest to name value pairs
Convert UnsubscribeRequest to name value pairs
Convert ListSubscriptionsByTopicRequest to name value pairs
Convert PublishRequest to name value pairs
Response Unmarshaller for VerifyEmailAddress operation
Get Send Statistics Request Marshaller
Response Unmarshaller for DeleteVerifiedEmailAddress operation
Container for the parameters to the SendEmail operation.
Composes an email message, based on input data, and then
immediately queues the message for sending.
Default constructor for a new SendEmailRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new SendEmailRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The sender's email address.
The destination for this email, composed of To:, From:, and CC: fields.
The message to be sent.
Sets the Source property
The value to set for the Source property
this instance
Sets the Destination property
The value to set for the Destination property
this instance
Sets the Message property
The value to set for the Message property
this instance
Adds elements to the ReplyToAddresses collection
The values to add to the ReplyToAddresses collection
this instance
Adds elements to the ReplyToAddresses collection
The values to add to the ReplyToAddresses collection
this instance
Sets the ReturnPath property
The value to set for the ReturnPath property
this instance
The sender's email address.
The destination for this email, composed of To:, From:, and CC: fields.
The message to be sent.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
The email address to which bounce notifications are to be forwarded. If the message cannot be delivered to the recipient, then an error
message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the
ReturnPath parameter.
Perform multiple PutAttribute operations in a single call. This helps you yield savings in round trips and
latencies, and enables Amazon SimpleDB to optimize requests, which generally yields better throughput.
Amazon SimpleDB uniquely identifies attributes in an item by their name/value combinations. For example, a
single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However,
it cannot have two attribute instances where both the attribute name and attribute value are the same.
Optionally, you can supply the Replace parameter for each individual attribute. Setting this value to true
causes the new attribute value to replace the existing attribute value(s) if any exist. Otherwise, it simply
inserts the attribute values. For example, if an item has the attributes { 'a', '1' }, { 'b', '2'}, and { 'b', '3' }
and the requestor calls BatchPutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true,
the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }. This occurs because the new 'b'
attribute replaces the old value.
Note: You cannot specify an empty string as an item or attribute name.
The operation succeeds or fails in its entirety. There are no partial puts.
You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of
concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.
This operation is vulnerable to exceeding the maximum URL size.
The following limitations are enforced for this operation:
* 256 attribute name-value pairs per item
* 1 MB request size
* 1 billion attributes per domain
* 10 GB of total user data storage per domain
* 25 item limit per BatchPutAttributes operation
Sets the DomainName property
The name of the domain in which to perform the operation.
this instance
Checks if DomainName property is set
true if DomainName property is set
Sets the Item property
Items represent individual objects that contain one or more attribute name-value pairs.
this instance
Checks if Item property is set
true if Item property is set
Gets and sets the DomainName property.
The name of the domain in which to perform the operation.
Gets and sets the Item property.
Items represent individual objects that contain one or more attribute name-value pairs.
Amazon Simple DB Exception provides details of errors
returned by Amazon Simple DB service
Initializes a new AmazonSimpleDBException with default values.
Initializes a new AmazonSimpleDBException with a specified
error message
A message that describes the error
Constructs AmazonSimpleDBException with message and status code
A message that describes the error
HTTP status code for error response
Initializes a new AmazonSimpleDBException from the inner exception that is
the cause of this exception.
The nested exception that caused the AmazonS3Exception
Initializes a new AmazonSimpleDBException with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Serializes this instance of AmazonSimpleDBException.
The object that holds the serialized object data.
The contextual information about the source or destination.
Constructs AmazonSimpleDBException with message and wrapped exception
A message that describes the error
The nested exception that caused the AmazonS3Exception
Constructs AmazonSimpleDBException with information available from service
A message that describes the error
HTTP status code for error response
Error Code returned by the service
Error type. Possible types: Sender, Receiver or Unknown
Measure of machine utilization for this request
Request ID returned by the service
Compete xml found in response
Gets and sets of the ErrorCode property.
Gets and sets of the ErrorType property.
Gets error message
Gets status code returned by the service if available. If status
code is set to -1, it means that status code was unavailable at the
time exception was thrown
Gets measure of machine utilization for this request
Gets XML returned by the service if available.
Gets Request ID returned by the service if available.
Provides utilities used by the Amazon S3 client implementation.
These utilities might be useful to consumers of the Amazon S3
library.
URL encodes a string. If the path property is specified,
the accepted path characters {/+:} are not encoded.
The string to encode
Whether the string is a URL path or not
Converts a non-seekable stream into a System.IO.MemoryStream.
A MemoryStream's position can be moved arbitrarily
The stream to be converted
A seekable MemoryStream
MemoryStreams use byte arrays as their backing store.
Please use this judicially as it is likely that a very large
stream will cause system resources to be used up.
Computes RFC 2104-compliant HMAC signature
The data to be signed
The secret signing key
The algorithm to sign the data with
A string representing the HMAC signature
Generates an md5Digest for the file-stream specified
The Stream for which the MD5 Digest needs
to be computed.
Whether the hash should be base64 encoded
A string representation of the hash with or w/o base64 encoding
Generates an MD5 Digest for the string-based content
The content for which the MD5 Digest needs
to be computed.
Whether the returned checksum should be
base64 encoded.
A string representation of the hash with or w/o base64 encoding
Builds and returns the name value collection
that can be added to the HTTP headers for the request
The key to be added to the headers (eg. Content-Body)
The value of the key being added
A NameValueCollection with just one key-value pair
Version2 S3 buckets adhere to RFC 1035:
- Less than 255 characters, with each label less than 63 characters.
- Label must start with a letter
- Label must end with a letter or digit
- Label can have a string of letter, digits and hyphens in the middle.
- Although names can be case-sensitive, no significance is attached to the case.
- RFC 1123: Allow label to start with letter or digit (e.g. 3ware.com works)
- RFC 2181: No restrictions apart from the length restrictions.
S3 V2 will start with RFCs 1035 and 1123 and impose the following additional restrictions:
- Length between 3 and 63 characters (to allow headroom for upper-level domains,
as well as to avoid separate length restrictions for bucket-name and its labels
- Only lower-case to avoid user confusion.
- No dotted-decimal IPv4-like strings
The BucketName to validate if V2 addressing should be used
True if the BucketName should use V2 bucket addressing, false otherwise
S3 v2 Bucket restrictions
Determines whether an S3 bucket exists or not.
This is done by:
1. Creating a PreSigned Url for the bucket (with an expiry date at the end of this decade)
2. Making a HEAD request to the Url
The name of the bucket to check.
The Amazon S3 Client to use for S3 specific operations.
Determines MIME type from a file extension
The extension of the file
The MIME type for the extension, or text/plain
Sets the storage class for the S3 Object to the value
specified.
The S3 Object whose storage class needs changing
The new Storage Class for the object
The Amazon S3 Client to use for S3 specific operations.
Sets the storage class for the S3 Object to the value
specified.
The name of the bucket in which the key is stored
The key of the S3 Object whose storage class needs changing
The new Storage Class for the object
The Amazon S3 Client to use for S3 specific operations.
Sets the storage class for the S3 Object Version to the value
specified.
The S3 Object Version whose storage class needs changing
The new Storage Class for the object
The Amazon S3 Client to use for S3 specific operations.
Sets the storage class for the S3 Object's Version to the value
specified.
The name of the bucket in which the key is stored
The key of the S3 Object whose storage class needs changing
The version of the S3 Object whose storage class needs changing
The new Storage Class for the object
The Amazon S3 Client to use for S3 specific operations.
Formats the current date as a GMT timestamp
A GMT formatted string representation
of the current date and time
Contains all the parameters
that can be set when making a this request with the
TransferUtility method.
Sets the name of the bucket
and returns this object instance,
enabling additional method calls to be chained together.
The name of the bucket.
This object instance, enabling additional method calls to be chained together.
Sets the key under which the Amazon S3 object is stored
and returns this object instance,
enabling additional method calls to be chained together.
The value that Key is set to
This object instance, enabling additional method calls to be chained together.
Sets the version ID of the Amazon S3 object
and returns this object instance,
enabling additional method calls to be chained together.
The version ID of the Amazon S3 object.
This object instance, enabling additional method calls to be chained together.
Sets the ModifiedSinceDate property for this request
and returns this object instance,
enabling additional method calls to be chained together.
When this is set, the Amazon S3 object is downloaded only if it
has been modified since the specified time.
Otherwise, Amazon S3 returns a 304 error code.
The value to set the ModifiedSinceDate property.
This object instance, enabling additional method calls to be chained together.
Sets the UnmodifiedSinceDate property for this request
and returns this object instance,
enabling additional method calls to be chained together.
When this is set, the Amazon S3 object is downloaded only if it
has been modified since the specified time.
Otherwise, Amazon S3 returns a 412 error code.
The value to set the UnmodifiedSinceDate property.
This object instance, enabling additional method calls to be chained together.
Sets the timeout property in milliseconds
and returns this object instance,
enabling additional method calls to be chained together.
The value of this property is assigned to the
ReadWriteTimeout and Timeout properties of the
HTTPWebRequest object used for Amazon S3 GET Object requests.
Set the timeout only if certain that
the file will not be transferred within the default intervals
for an HttpWebRequest.
The value of the timeout property in milliseconds.
A value less than or equal to 0 will be silently ignored.
This object instance, enabling additional method calls to be chained together.
The PutBucketResponse contains any headers returned by S3.
The GetObjectMetadataRequest contains the parameters used for the GetObjectMetadata operation.
For more information about the optional parameters,
refer:
Required Parameters: BucketName, Key
Optional Parameters: ModifiedSinceDate, UnmodifiedSinceDate, ETagToMatch, ETagToNotMatch
Sets the BucketName property for this request.
This is the S3 Bucket that contains the S3 Object with
the metadata you want.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object's metadata you want.
The value that Key is set to
this instance
Checks if Key property is set.
true if Key property is set.
Sets the ModifiedSinceDate property for this request.
When this is set the S3 object metadata is returned
only if it has been modified since the specified time,
otherwise returns a 304 (not modified).
The value that ModifiedSinceDate is set to
this instance
Checks if ModifiedSinceDate property is set.
true if ModifiedSinceDate property is set.
Sets the UnmodifiedSinceDate property for this request.
When this is set the S3 object metadata is returned only
if it has not been modified since the specified time,
otherwise return a 412 (precondition failed).
The value that UnmodifiedSinceDate is set to
this instance
Checks if UnmodifiedSinceDate property is set.
true if UnmodifiedSinceDate property is set.
Sets the ETagToMatch property for this request.
When this is set the S3 object metadatais returned
only if its entity tag (ETag) is the same as the one
specified, otherwise return a 412 (precondition failed).
The value that ETagToMatch is set to
this instance
Checks if ETagToMatch property is set.
true if ETagToMatch property is set.
Sets the ETagToNotMatch property for this request.
When this is set the S3 object metadata is returned
only if its entity tag (ETag) is different from the one
specified, otherwise return a 304 (not modified).
The value that ETagToNotMatch is set to
this instance
Checks if ETagToNotMatch property is set.
true if ETagToNotMatch property is set.
Sets the VersionId property for this request.
This is the VersionId for the S3 Object you want to Get Metatdata for.
The value that VersionId is set to
this instance
Checks if VersionId property is set.
true if VersionId property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the ModifiedSinceDate property.
Gets and sets the UnmodifiedSinceDate property.
Gets and sets the ETagToMatch property.
Gets and sets the ETagToNotMatch property.
Gets and sets the VersionId property.
This is the VersionId for the S3 Object you want to Get Metatdata for.
AccessControlList represents an ACL for S3.
An AccessControlList is represented by an Owner,
and a List of Grants, where each Grant is a Grantee
and a Permission.
Each bucket and object in Amazon S3 has an ACL that defines its access control policy.
When a request is made, Amazon S3 authenticates the request using its standard
authentication procedure and then checks the ACL to verify the sender was granted access
to the bucket or object. If the sender is approved, the request proceeds.
Otherwise, Amazon S3 returns an error.
An ACL is a list of grants. A grant consists of one grantee and one permission.
ACLs only grant permissions; they do not deny them.
For convenience, some commonly used Access Control Lists are defined in
S3CannedACL.
Note: Bucket and object ACLs are completely independent; an object does not inherit the ACL
from its bucket. For example, if you create a bucket and grant write access to another user,
you will not be able to access the user's objects unless the user explicitly grants access.
This also applies if you grant anonymous write access to a bucket. Only the user "anonymous"
will be able to access objects the user created unless permission is explicitly granted to
the bucket owner.
Important: We highly recommend that you do not grant the anonymous group write access to your
buckets as you will have no control over the objects others can store and their associated charges.
For more information, see Grantees and Permissions
Creates a S3Grant and adds it to the list of grants.
The grantee for the grant.
The permission for the grantee.
Removes a specific permission for the given grantee.
The grantee
The permission for the grantee to remove
Removes all permissions for the given grantee.
Returns a System.String that represents the AccessControlList Object
A System.String representation of the AccessControlList Object.
Sets the Owner property.
Owner property
this instance
Checks if Owner property is set.
true if Owner property is set.
Sets the Grants property.
Grants property
this instance
Checks if Grants property is set.
true if Grants property is set.
Gets and sets the Owner property.
Every bucket and object in Amazon S3 has an owner, the user that
created the bucket or object. The owner of a bucket or object cannot
be changed. However, if the object is overwritten by another user
(deleted and rewritten), the new object will have a new owner.
Note: Even the owner is subject to the ACL. For example, if an owner
does not have Permission.READ access to an object, the owner cannot read
that object. However, the owner of an object always has write access to the
access control policy (Permission.WriteAcp) and can change the ACL to
read the object.
Gets and sets the Grants property.
NotificationConfigurationList represents a notification configuration for a bucket
in S3. A configuration is a collection of topic configurations which contain the event
and topic arn. Currently only one event type is being supported with the possiblity of
more event types in the future.
Adds the arguments to the TopicConfigurations property.
TopicConfigurations added to the TopicConfigurations property
this instance
Creates a string representation of a NotificationConfigurationlist.
The string representation of the NotificationConfigurationlist.
Creates a xml representation of a NotificationConfigurationlist.
The xml representation of the NotificationConfigurationlist.
Gets and sets the TopicConfigurations property.
The GetBucketPolicyResponse contains the JSON string representation of the policy
any headers returned by S3.
The request to get the policy is return as the content
body of the response.
The policy
Gets and sets the Policy property.
Represents a request being sent to an Amazon Web Service, including the
parameters being sent as part of the request, the endpoint to which the
request should be sent, etc.
This class is only intended for internal use inside the AWS client libraries.
Callers shouldn't ever interact directly with objects of this class.
The type of original, user facing request represented by this request.
Returns a dictionary of the headers included in this request.
Returns a dictionary of the parameters included in this request.
Gets and Sets the endpoint for this request.
The name of the service to which this request is being sent.
Returns the original, user facing request object which this internal
request object is representing.
Default implementation of the IRequest interface.
This class is only intended for internal use inside the AWS client libraries.
Callers shouldn't ever interact directly with objects of this class.
Constructs a new DefaultRequest with the specified service name and the
original, user facing request object.
The orignal request that is being wrapped
The service name
Returns the original, user facing request object which this internal
request object is representing.
Returns a dictionary of the headers included in this request.
Returns a dictionary of the parameters included in this request.
Gets and Sets the endpoint for this request.
The name of the service to which this request is being sent.
ResetDBParameterGroupResult Unmarshaller
ReservedDBInstancesOffering Unmarshaller
DescribeReservedDBInstancesOfferingsResult Unmarshaller
Response Unmarshaller for DescribeDBParameters operation
Describe D B Parameter Groups Request Marshaller
Describe D B Instances Request Marshaller
Result Unmarshaller for DeleteDBSnapshot operation
This data type is used as a response element in the DescribeDBSecurityGroups action.
Sets the Status property
The value to set for the Status property
this instance
Sets the CIDRIP property
The value to set for the CIDRIP property
this instance
Specifies the status of the IP range.
Specifies the IP range.
This data type is used as a response element in the following actions:
- CreateDBInstance
- DescribeDBInstances
- DeleteDBInstance
Sets the Address property
The value to set for the Address property
this instance
Sets the Port property
The value to set for the Port property
this instance
Specifies the DNS address of the DB Instance.
Specifies the port that the database engine is listening on.
Container for the parameters to the DescribeDBParameterGroups operation.
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions
of the specified DBParameterGroup.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The name of a specific database parameter group to return details for. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
Container for the parameters to the DescribeDBInstances operation.
Returns information about provisioned RDS instances. This API supports pagination.
Sets the DBInstanceIdentifier property
The value to set for the DBInstanceIdentifier property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This
parameter isn't case sensitive. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens
- First character
must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords .
The results from the CreateDBSecurityGroup action.
Gets and sets the CreateDBSecurityGroupResult property.
Contains the result of a successful invocation of the CreateDBSecurityGroup
action.
The results from the AuthorizeDBSecurityGroupIngress action.
Gets and sets the AuthorizeDBSecurityGroupIngressResult property.
Contains the result of a successful invocation of the AuthorizeDBSecurityGroupIngress
action.
Returns information about the UpdateJobResult response and response metadata.
Gets and sets the UpdateJobResult property.
Output structure for the UpateJob operation.
Response Unmarshaller for UpdateJob operation
Response Unmarshaller for UpdateServerCertificate operation
Response Unmarshaller for UpdateLoginProfile operation
Response Unmarshaller for UpdateGroup operation
LoginProfile Unmarshaller
Delete User Policy Request Marshaller
CreateUserResult Unmarshaller
Returns information about the ResyncMFADevice response metadata.
The ResyncMFADevice operation has a void result type.
Container for the parameters to the ListUsers operation.
Lists the Users that have the specified path prefix. If there
are none, the action returns an empty list. You can
paginate the results using the MaxItems and Marker
parameters.
Sets the PathPrefix property
The value to set for the PathPrefix property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all User names whose path
starts with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing
all User names.
Constraints:
-
Length
1 - 512
-
Pattern
\u002F[\u0021-\u007F]*
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are
truncated. Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this parameter only when paginating results to indicate the maximum number of User names you want in the response. If there are
additional User names beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Container for the parameters to the ListGroupsForUser operation.
Lists the groups the specified User belongs to. You
can paginate the results using the MaxItems and Marker
parameters.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The name of the User to list groups for.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups
beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
AmazonIdentityManagementService exception
Constructs a new LimitExceededException with the specified error
message.
Describes the error encountered.
AmazonIdentityManagementService exception
Constructs a new DuplicateCertificateException with the specified error
message.
Describes the error encountered.
Run Job Flow Request Marshaller
Response Unmarshaller for AddInstanceGroups operation
The result of the RunJobFlow operation.
Sets the JobFlowId property
The value to set for the JobFlowId property
this instance
An unique identifier for the job flow.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
ListenerDescription Unmarshaller
Response Unmarshaller for CreateLoadBalancerListeners operation
Response Unmarshaller for CreateLBCookieStickinessPolicy operation
Response Unmarshaller for CreateAppCookieStickinessPolicy operation
The output for the SetLoadBalancerPoliciesOfListener action.
The HealthCheck data type.
Default constructor for a new HealthCheck object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new HealthCheck object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
Specifies the instance being checked. The protocol is either TCP or HTTP. The range of valid ports is one (1) through
65535. TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open
a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. For HTTP,
the situation is different. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this
case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is
considered unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Specifies the approximate interval, in seconds, between health checks of an individual instance.
Specifies the amount of time, in seconds, during which no response means a failed health probe. This value
must be less than the Interval value.
Specifies the number of consecutive health probe failures required before moving the instance to the
Unhealthy state.
Specifies the number of consecutive health probe successes required before moving the instance to the
Healthy state.
Sets the Target property
The value to set for the Target property
this instance
Sets the Interval property
The value to set for the Interval property
this instance
Sets the Timeout property
The value to set for the Timeout property
this instance
Sets the UnhealthyThreshold property
The value to set for the UnhealthyThreshold property
this instance
Sets the HealthyThreshold property
The value to set for the HealthyThreshold property
this instance
Specifies the instance being checked. The protocol is either TCP or HTTP. The range of valid ports is one (1) through 65535. TCP is
the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to
the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. For HTTP, the situation is
different. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET
request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered
unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Specifies the approximate interval, in seconds, between health checks of an individual instance.
Constraints:
-
Range
1 - 300
Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the
Interval value.
Constraints:
-
Range
1 - 300
Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.
Constraints:
-
Range
2 - 10
Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
Constraints:
-
Range
2 - 10
Container for the parameters to the EnableAvailabilityZonesForLoadBalancer operation.
Adds one or more EC2 Availability Zones to the LoadBalancer. The LoadBalancer evenly distributes requests across all
its registered Availability Zones that contain instances. As a result, the client must ensure that its LoadBalancer is appropriately scaled
for each registered Availability Zone. NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region
as the Availability Zones for which the LoadBalancer was created.
Default constructor for a new EnableAvailabilityZonesForLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new EnableAvailabilityZonesForLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of new Availability Zones for the LoadBalancer. Each Availability Zone must be in the same Region as
the LoadBalancer.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of new Availability Zones for the LoadBalancer. Each Availability Zone must be in the same Region as the LoadBalancer.
Returns information about the DeleteLoadBalancerListenersResult response and response metadata.
Gets and sets the DeleteLoadBalancerListenersResult property.
The output for the DeleteLoadBalancerListeners action.
Returns information about the CreateAppCookieStickinessPolicyResult response and response metadata.
Gets and sets the CreateAppCookieStickinessPolicyResult property.
The output for the CreateAppCookieStickinessPolicy action.
Container for the parameters to the UpdateApplication operation.
Updates the specified application to have the specified properties. NOTE: If a property (for example,
description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue
error.
Constraints:
-
Length
1 - 100
A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description.
Constraints:
-
Length
0 - 200
UpdateConfigurationTemplateResult Unmarshaller
Response Unmarshaller for UpdateApplication operation
Response Unmarshaller for DescribeEvents operation
AmazonElasticBeanstalk exception
Constructs a new TooManyApplicationsException with the specified error
message.
Describes the error encountered.
Container for the parameters to the RequestEnvironmentInfo operation.
Initiates a request to compile the specified type of information of the deployed environment. Setting the
InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your
environment. Use RetrieveEnvironmentInfo to access the compiled information. Related Topics
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the InfoType property
The value to set for the InfoType property
this instance
The ID of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an
InvalidParameterValue error.
The name of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an
InvalidParameterValue error.
Constraints:
-
Length
4 - 23
The type of information to request.
Constraints:
-
Allowed Values
tail
Describes the AWS resources in use by this environment. This data is live.
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Adds elements to the AutoScalingGroups collection
The values to add to the AutoScalingGroups collection
this instance
Adds elements to the AutoScalingGroups collection
The values to add to the AutoScalingGroups collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the LaunchConfigurations collection
The values to add to the LaunchConfigurations collection
this instance
Adds elements to the LaunchConfigurations collection
The values to add to the LaunchConfigurations collection
this instance
Adds elements to the LoadBalancers collection
The values to add to the LoadBalancers collection
this instance
Adds elements to the LoadBalancers collection
The values to add to the LoadBalancers collection
this instance
Adds elements to the Triggers collection
The values to add to the Triggers collection
this instance
Adds elements to the Triggers collection
The values to add to the Triggers collection
this instance
The name of the environment.
Constraints:
-
Length
4 - 23
The AutoScalingGroups used by this environment.
The Amazon EC2 instances used by this environment.
The Auto Scaling launch configurations in use by this environment.
The LoadBalancers in use by this environment.
The AutoScaling triggers in use by this environment.
Result message wrapping a list of event descriptions.
Adds elements to the Events collection
The values to add to the Events collection
this instance
Adds elements to the Events collection
The values to add to the Events collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of EventDescription.
If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next
batch of events.
Result message containing a list of environment resource descriptions.
Sets the EnvironmentResources property
The value to set for the EnvironmentResources property
this instance
A list of EnvironmentResourceDescription.
Container for the parameters to the DescribeConfigurationSettings operation.
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the
configuration set associated with a running environment. When describing the settings for the configuration set associated
with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other
is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related
Topics
- DeleteEnvironmentConfiguration
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
The application for the environment or configuration template.
Constraints:
-
Length
1 - 100
The name of the configuration template to describe.
Constraints:
-
Length
1 - 100
The name of the environment to describe.
Constraints:
-
Length
4 - 23
Returns information about the DeleteEnvironmentConfiguration response metadata.
The DeleteEnvironmentConfiguration operation has a void result type.
Container for the parameters to the DeleteEnvironmentConfiguration operation.
Deletes the draft configuration associated with the running environment. Updating a running environment with any
configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the
update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in
process or has failed. The draft configuration remains in existence until it is deleted with this action.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
The name of the application the environment is associated with.
Constraints:
-
Length
1 - 100
The name of the environment to delete the draft configuration from.
Constraints:
-
Length
4 - 23
VPC
Sets the VpcId property
The VPC's ID
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the VpcState property
The current state of the VPC (pending or available).
this instance
Checks if VpcState property is set
true if VpcState property is set
Sets the CidrBlock property
The CIDR block the VPC covers
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the DhcpOptionsId property
The ID of the set of DHCP options you've
associated with the VPC
(or "default" if
the default options are
associated with the VPC).
this instance
Checks if DhcpOptionsId property is set
true if DhcpOptionsId property is set
Sets the Tag property
A list of tags for the Vpc.
this instance
Checks if Tag property is set
true if Tag property is set
Checks if InstanceTenancy property is set
true if InstanceTenancy property is set
Sets the InstanceTenancy property
The allowed tenancy of instances launched into the VPC.
this instance
Gets and sets the VpcId property.
The VPC's ID
Gets and sets the VpcState property.
The current state of the VPC (pending or available).
Gets and sets the CidrBlock property.
The CIDR block the VPC covers
Gets and sets the DhcpOptionsId property.
The ID of the set of DHCP options you've
associated with the VPC
(or "default" if
the default options are
associated with the VPC).
Gets and sets the Tag property.
A list of tags for the Vpc.
Gets and sets the InstanceTenancy property.
The allowed tenancy of instances launched into the VPC.
Represents metadata to associate with Amazon EC2 resources.
Each tag consists of a user-defined key and value.
Use tags to categorize EC2 resources, such as by purpose,
owner, or environment.
Sets the Key property
The tag's key.
this instance
Checks if Key property is set
true if Key property is set
Sets the Value property
The tag's value.
this instance
Checks if Value property is set
true if Value property is set
Gets and sets the Key property.
The tag's key.
Gets and sets the Value property.
The tag's value.
Result of the Request Spot Instances operation.
Checks if SpotInstanceRequest property is set
true if SpotInstanceRequest property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SpotInstanceRequest property.
A list of the SpotInstanceRequest objects returned by the service.
The Response for the
ReplaceRouteTableAssociation operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ReplaceRouteTableAssociationResult property is set
true if ReplaceRouteTableAssociationResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ReplaceRouteTableAssociationResult property.
ReplaceRouteTableAssociation Result
Represents an active license in use and attached to an Amazon EC2 instance.
Sets the Pool property
The license pool from which to take a license when starting
Amazon EC2 instances in the associated RunInstances request.
this instance
Checks if Pool property is set
true if Pool property is set
Gets and sets the Pool property.
The license pool from which to take a license when starting
Amazon EC2 instances in the associated RunInstances request.
DHCP Options
Sets the DhcpOptionsId property
The ID of the set of DHCP options
this instance
Checks if DhcpOptionsId property is set
true if DhcpOptionsId property is set
Sets the Configuration property
Information about the set of DHCP options
this instance
Checks if Configuration property is set
true if Configuration property is set
Sets the Tag property
A list of tags for the DhcpOptions.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the DhcpOptionsId property.
The ID of the set of DHCP options
Gets and sets the Configuration property.
Information about the set of DHCP options
Gets and sets the Tag property.
A list of tags for the DhcpOptions.
Detach Vpn Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Checks if License property is set
true if License property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the License property.
Specifies active licenses in use and attached
to an Amazon EC2 instance.
Returns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns
information for those instances.
If you do not specify instance IDs, Amazon EC2 returns information
for all relevant instances. If you
specify an invalid instance ID, a fault is returned.
If you specify an instance that you do not own, it will not be
included in the returned results.
Recently terminated instances might appear in the returned results.This
interval is usually less than one hour.
Sets the InstanceId property
Instance IDs to describe.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified Instances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the InstanceId property.
Instance IDs to describe.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified Instances.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
Information about the instance attribute.
Checks if InstanceAttribute property is set
true if InstanceAttribute property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the InstanceAttribute property.
List of instance attributes.
Describe Images Result
Checks if Image property is set
true if Image property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Image property.
List of AMIs
Describe Dhcp Options Result
Checks if DhcpOptions property is set
true if DhcpOptions property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the DhcpOptions property.
List of DHCP options
Delete Vpc Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Delete Subnet Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Volume Response
Checks if CreateVolumeResult property is set
true if CreateVolumeResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CreateVolumeResult property.
Create Volume Result
Gets and sets the ResponseMetadata property.
Response Metadata
Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC. If
you add more than one subnet to a VPC, they're set up in a star topology with a
logical router in the middle. If you feel you need more than 20 subnets, you can
request more by going to http://aws.amazon.com/contact-us/vpc-request/.
When you create each subnet, you provide the VPC ID and the CIDR block you
want for the subnet. Once you create a subnet, you can't change its CIDR block.
The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you
want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you
create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap.
The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP
addresses), and the largest uses a /18 netmask (16,384 IP addresses).
*Important*
AWS reserves both the first four and the last IP address in each subnet's CIDR block.
They're not available for use.
AWS might delete any subnet you create with this operation if you leave it inactive
for an extended period of time (inactive means that there are no running Amazon
EC2 instances in the subnet).
Sets the VpcId property
The ID of the VPC where you want to create the
subnet.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the CidrBlock property
The CIDR block you want the subnet to cover.
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the AvailabilityZone property
The Availability Zone you want the subnet in.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Gets and sets the VpcId property.
The ID of the VPC where you want to create the
subnet.
Gets and sets the CidrBlock property.
The CIDR block you want the subnet to cover.
Gets and sets the AvailabilityZone property.
The Availability Zone you want the subnet in.
CreateSecurityGroup Result
Checks if GroupId property is set
true if GroupId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the GroupId property.
ID that AWS assigns to the security group.
Creates an entry (i.e., rule) in a network ACL with a rule number you specify. Each network ACL has a
set of numbered ingress rules and a separate set of numbered egress rules. When determining whether
a packet should be allowed in or out of a subnet associated with the ACL, Amazon VPC processes the
entries in the ACL according to the rule numbers, in ascending order.
We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number
them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing
ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete
the old one.
For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User
Guide.
Sets the NetworkAclId property
ID of the ACL where the entry will be created.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the RuleNumber property
Rule number to assign to the entry (e.g., 100). ACL
entries are processed in ascending order by rule
number.
this instance
Checks if RuleNumber property is set
true if RuleNumber property is set
Sets the Protocol property
IP protocol the rule applies to.
Valid Values: 6 for tcp | 17 for udp | 1 for icmp or an IP protocol number.
this instance
Checks if Protocol property is set
true if Protocol property is set
Sets the RuleAction property
Whether to allow or deny traffic that matches the rule.
Valid Values: allow | deny
this instance
Checks if RuleAction property is set
true if RuleAction property is set
Sets the Egress property
Whether this rule applies to egress traffic from the
subnet (true) or ingress traffic to the subnet (false).
this instance
Checks if Egress property is set
true if Egress property is set
Sets the CidrBlock property
The CIDR range to allow or deny, in CIDR notation
(e.g., 172.16.0.0/24).
this instance
Checks if CidrBlock property is set
true if CidrBlock property is set
Sets the Icmp property
For the ICMP protocol, this is the ICMP type and code.
this instance
Checks if Icmp property is set
true if Icmp property is set
Sets the PortRange property
For the TCP or UDP protocols, the range of ports the rule applies to.
this instance
Checks if PortRange property is set
true if PortRange property is set
Gets and sets the NetworkAclId property.
ID of the ACL where the entry will be created.
Gets and sets the RuleNumber property.
Rule number to assign to the entry (e.g., 100). ACL
entries are processed in ascending order by rule
number.
Gets and sets the Protocol property.
IP protocol the rule applies to.
Valid Values: 6 for tcp | 17 for udp | 1 for icmp or an IP protocol number.
Gets and sets the RuleAction property.
Whether to allow or deny traffic that matches the rule.
Valid Values: allow | deny
Gets and sets the Egress property.
Whether this rule applies to egress traffic from the
subnet (true) or ingress traffic to the subnet (false).
Gets and sets the CidrBlock property.
The CIDR range to allow or deny, in CIDR notation
(e.g., 172.16.0.0/24).
Gets and sets the Icmp property.
For the ICMP protocol, this is the ICMP type and code.
Gets and sets the PortRange property.
For the TCP or UDP protocols, the range of ports the rule applies to.
Information about the created image.
Checks if ImageId property is set
true if ImageId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ImageId property.
The ID of the AMI.
Bundle Instance Result
Checks if BundleTask property is set
true if BundleTask property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the BundleTask property.
Attach Volume Result
Checks if Attachment property is set
true if Attachment property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Attachment property.
Volume Attachment
Associates a set of DHCP options (that you've previously created) with the
specified VPC. Or, associates the default DHCP options with the
VPC. The default set consists of the standard EC2 host name, no domain name, no
DNS server, no NTP server, and no NetBIOS server or node type.
After you associate the options with the VPC, any existing instances
and all new instances that you launch in that VPC use the options. For more
information about the supported DHCP options and using them with
Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud
Developer Guide.
Sets the DhcpOptionsId property
The ID of the DHCP options you want to associate with the VPC, or
"default" if you want to associate the default DHCP options with the VPC.
this instance
Checks if DhcpOptionsId property is set
true if DhcpOptionsId property is set
Sets the VpcId property
The ID of the VPC you want to associate the DHCP options with.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the DhcpOptionsId property.
The ID of the DHCP options you want to associate with the VPC, or
"default" if you want to associate the default DHCP options with the VPC.
Gets and sets the VpcId property.
The ID of the VPC you want to associate the DHCP options with.
Allocate Address Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if AllocateAddressResult property is set
true if AllocateAddressResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the AllocateAddressResult property.
Allocate Address Result
Returns information about the SetAlarmState response metadata.
The SetAlarmState operation has a void result type.
AmazonCloudWatch exception
Constructs a new InvalidParameterValueException with the specified error
message.
Describes the error encountered.
Returns information about the EnableAlarmActions response metadata.
The EnableAlarmActions operation has a void result type.
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.
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
Adds elements to the AlarmNames collection
The values to add to the AlarmNames collection
this instance
Sets the AlarmNamePrefix property
The value to set for the AlarmNamePrefix property
this instance
Sets the StateValue property
The value to set for the StateValue property
this instance
Sets the ActionPrefix property
The value to set for the ActionPrefix property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of alarm names to retrieve information for.
Constraints:
-
Length
0 - 100
The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
Constraints:
-
Length
1 - 255
The state value to be used in matching alarms.
Constraints:
-
Allowed Values
OK, ALARM, INSUFFICIENT_DATA
The action name prefix.
Constraints:
-
Length
1 - 1024
The maximum number of alarm descriptions to retrieve.
Constraints:
-
Range
1 - 100
The token returned by a previous call to indicate that there is more data available.
The output for the DescribeAlarmsForMetric action.
Adds elements to the MetricAlarms collection
The values to add to the MetricAlarms collection
this instance
Adds elements to the MetricAlarms collection
The values to add to the MetricAlarms collection
this instance
A list of information for each alarm with the specified metric.
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.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the HistoryItemType property
The value to set for the HistoryItemType property
this instance
Sets the StartDate property
The value to set for the StartDate property
this instance
Sets the EndDate property
The value to set for the EndDate property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
The name of the alarm.
Constraints:
-
Length
1 - 255
The type of alarm histories to retrieve.
Constraints:
-
Allowed Values
ConfigurationUpdate, StateUpdate, Action
The starting date to retrieve alarm history.
The ending date to retrieve alarm history.
The maximum number of alarm history records to retrieve.
Constraints:
-
Range
1 - 100
The token returned by a previous call to indicate that there is more data available.
The SetStreamingDistributionConfigResponse contains the distribution's modified
information structure along with any other headers returned by
CloudFront.
Gets and sets the ETag property.
The Distribution's ETag is also set if
possible.
The ListOriginAccessIdentitiesResponse contains the ListOriginAccessIdentitiesResult and
any headers or metadata returned by CloudFront.
Amazon CloudFront Get Origin Access Identity List
Gets the List of Origin Access Identities returned by CloudFront
Gets and sets the Marker property.
Gets and sets the MaxItems property.
Gets and sets the NextMarker property.
Gets and sets the IsTruncated property.
The GetStreamingDistributionConfigResponse contains the StreamingDistribution's configuration
and any headers returned by CloudFront.
Gets and Sets the StreamingDistributionConfig property.
Gets and sets the ETag property.
The Streaming Distribution's Configuration ETag is also
set if possible.
The DeleteStreamingDistributionRequest contains the parameters used for the DeleteStreamingDistribution operation.
Required Parameters: Id
Required Parameters: ETag
Sets the Id property of this request to the value passed in.
The StreamingDistribution's id
The request with the Id property set
Sets the ETag property of this request to the value passed in.
The StreamingDistribution's etag
The request with the ETag property set
Gets and sets the Id property for the StreamingDistribution
Gets and sets the ETag property for the StreamingDistribution
AmazonCloudFormation exception
Constructs a new ValidationErrorException with the specified error
message.
Describes the error encountered.
Container for the parameters to the ValidateTemplate operation.
Validates a specified template.
Sets the TemplateBody property
The value to set for the TemplateBody property
this instance
Sets the TemplateURL property
The value to set for the TemplateURL property
this instance
String containing the template body. (For more information, go to the AWS CloudFormation User Guide.) Conditional: You must pass
TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Constraints:
-
Length
1 -
Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For
more information, go to the AWS CloudFormation User
Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Constraints:
-
Length
1 - 1024
Describe Stack Resource Request Marshaller
Describe Stack Events Request Marshaller
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 DescribeStacks API. NOTE: Currently, the limit for stacks is 20 stacks per account per
region.
Sets the StackName property
The value to set for the StackName property
this instance
Sets the TemplateBody property
The value to set for the TemplateBody property
this instance
Sets the TemplateURL property
The value to set for the TemplateURL property
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Sets the DisableRollback property
The value to set for the DisableRollback property
this instance
Sets the TimeoutInMinutes property
The value to set for the TimeoutInMinutes property
this instance
Adds elements to the NotificationARNs collection
The values to add to the NotificationARNs collection
this instance
Adds elements to the NotificationARNs collection
The values to add to the NotificationARNs collection
this instance
The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case
sensitive) and start with an alpha character. Maximum length of the name is 255 characters.
Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.) Condition: You must pass
TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
Constraints:
-
Length
1 -
Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For
more information, go to the AWS CloudFormation User
Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Constraints:
-
Length
1 - 1024
A list of Parameter structures.
Boolean to enable or disable rollback on stack creation failures.
Default: false
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to
false, the stack will be rolled back.
Constraints:
-
Range
1 -
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
Constraints:
-
Length
0 - 5
DescribeScheduledActionsResult Unmarshaller
DescribeScalingProcessTypesResult Unmarshaller
DescribePoliciesResult Unmarshaller
DescribeMetricCollectionTypesResult Unmarshaller
Delete Policy Request Marshaller
Response Unmarshaller for DeleteNotificationConfiguration operation
Response Unmarshaller for CreateAutoScalingGroup operation
Returns information about the PutNotificationConfiguration response metadata.
The PutNotificationConfiguration operation has a void result type.
Container for the parameters to the DeleteNotificationConfiguration operation.
Deletes notifications created by PutNotificationConfiguration.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the TopicARN property
The value to set for the TopicARN property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns information about the CreateLaunchConfiguration response metadata.
The CreateLaunchConfiguration operation has a void result type.
The available AWS access control policy actions for AWS CloudFormation.
Represents any action being taken on AWS CloudFormation.
Action for creating a stack as specified in the template.
Action for deleting a stack.
Action for describing stacks.
Action for describing stack events.
Action for describing stack resources.
Action for getting the template body for a specified stack name.
Action for validating a specified template.
Encapsulates the metadata and result of the RemovePermission action.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
The Metadata used to identify the service request uniquely.
Response Unmarshaller for SendRawEmail operation
Send Raw Email Request Marshaller
SendEmailResult Unmarshaller
Container for the parameters to the SendRawEmail operation.
Sends an email message, with header and content specified by the
client. The SendRawEmail action is useful for sending multipart
MIME emails, with attachments or inline content. The raw
text of the message must comply with Internet email standards;
otherwise, the message cannot be sent. For more information, go to
the Amazon SES Developer Guide.
Default constructor for a new SendRawEmailRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new SendRawEmailRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The raw text of the message. The client is responsible for ensuring the following: - Message must contain a
header and a body, separated by a blank line.
- All required header fields must be present.
- Each part of a multipart MIME
message must be formatted properly.
- MIME content types must be among those supported by Amazon SES. Refer to the Amazon SES Developer Guide for more details.
- Content must be
base64-encoded, if MIME requires it.
Sets the Source property
The value to set for the Source property
this instance
Adds elements to the Destinations collection
The values to add to the Destinations collection
this instance
Adds elements to the Destinations collection
The values to add to the Destinations collection
this instance
Sets the RawMessage property
The value to set for the RawMessage property
this instance
The sender's email address.
A list of destinations for the message.
The raw text of the message. The client is responsible for ensuring the following: - Message must contain a header and a body,
separated by a blank line.
- All required header fields must be present.
- Each part of a multipart MIME message must be
formatted properly.
- MIME content types must be among those supported by Amazon SES. Refer to the Amazon SES Developer Guide for more details.
- Content must be
base64-encoded, if MIME requires it.
Represents sending statistics data. Each SendDataPoint
contains statistics for a 15-minute period of sending activity.
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the DeliveryAttempts property
The value to set for the DeliveryAttempts property
this instance
Sets the Bounces property
The value to set for the Bounces property
this instance
Sets the Complaints property
The value to set for the Complaints property
this instance
Sets the Rejects property
The value to set for the Rejects property
this instance
Time of the data point.
Number of emails that have been enqueued for sending.
Number of emails that have bounced.
Number of unwanted emails that were rejected by recipients.
Number of emails rejected by Amazon SES.
AmazonSimpleEmailService exception
Constructs a new MessageRejectedException with the specified error
message.
Describes the error encountered.
An attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items.
Sets the Name property
Name of attribute associated with an item. Allowed characters are all UTF-8 characters valid
in XML documents. Control characters and any sequences that are not valid in XML are not allowed. These
strings can be up to 1024 bytes long.
this instance
Checks if Name property is set
true if Name property is set
Sets the Value property
Value of the attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items. Allowed characters are all UTF-8 characters valid in
XML documents. Control characters and any sequences that are not valid in XML are not allowed. These strings
can be up to 1024 bytes long.
this instance
Checks if Value property is set
true if Value property is set
Sets the Replace property
Replace property
this instance
Checks if Replace property is set
true if Replace property is set
Gets and sets the Name property.
Name of attribute associated with an item. Allowed characters are all UTF-8 characters valid
in XML documents. Control characters and any sequences that are not valid in XML are not allowed. These
strings can be up to 1024 bytes long.
Gets and sets the Value property.
Value of the attribute associated with an item. Similar to columns on a spreadsheet, attributes represent
categories of data that can be assigned to items. Allowed characters are all UTF-8 characters valid in
XML documents. Control characters and any sequences that are not valid in XML are not allowed. These strings
can be up to 1024 bytes long.
Gets and sets the Replace property.
Returns all of the attributes associated with the item. Optionally, the attributes returned can
be limited to one or more specified attribute name parameters. If the item does not exist on the
replica that was accessed for this operation, an empty set is returned. The system does not return
an error as it cannot guarantee the item does not exist on other replicas.
Sets the GetAttributesResult property
Returns all of the attributes associated with the item. Optionally, the attributes returned can
be limited to one or more specified attribute name parameters. If the item does not exist on the
replica that was accessed for this operation, an empty set is returned. The system does not return
an error as it cannot guarantee the item does not exist on other replicas.
this instance
Checks if GetAttributesResult property is set
true if GetAttributesResult property is set
Sets the ResponseMetadata property
Information about the request provided by Amazon SimpleDB.
this instance
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation for this object
XML String
Gets and sets the GetAttributesResult property.
Returns all of the attributes associated with the item. Optionally, the attributes returned can
be limited to one or more specified attribute name parameters. If the item does not exist on the
replica that was accessed for this operation, an empty set is returned. The system does not return
an error as it cannot guarantee the item does not exist on other replicas.
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SimpleDB.
Returns information about the domain, including when the domain was created, the number of items and
attributes, and the size of attribute names and values.
Sets the DomainName property
The name of the domain for which to display metadata.
this instance
Checks if DomainName property is set
true if DomainName property is set
Gets and sets the DomainName property.
The name of the domain for which to display metadata.
Creates a new domain. The domain name must be unique among the domains associated with the account used in the request.
The operation might take 10 or more seconds to complete. Creating a domain is an idempotent operation; running it
multiple times using the same domain name will not result in an error response. You can create up to 100 domains
per account. If you require additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.
Sets the DomainName property
The name of the domain to create. The name can range between 3 and 255 characters
and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
this instance
Checks if DomainName property is set
true if DomainName property is set
Gets and sets the DomainName property.
The name of the domain to create. The name can range between 3 and 255 characters
and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
Configuration for accessing Amazon Simple DB service
Sets the SignatureMethod property
SignatureMethod property
this instance
Checks if SignatureMethod property is set
true if SignatureMethod property is set
Sets the SignatureVersion property
SignatureVersion property
this instance
Checks if SignatureVersion property is set
true if SignatureVersion property is set
Sets the UserAgent property
UserAgent property
this instance
Checks if UserAgent property is set
true if UserAgent property is set
Sets the ServiceURL property
ServiceURL property
this instance
Checks if ServiceURL property is set
true if ServiceURL property is set
Sets the ProxyHost property
ProxyHost property
this instance
Checks if ProxyHost property is set
true if ProxyHost property is set
Sets the ProxyPort property
ProxyPort property
this instance
Checks if ProxyPort property is set
true if ProxyPort property is set
Sets the MaxErrorRetry property
MaxErrorRetry property
this instance
Checks if MaxErrorRetry property is set
true if MaxErrorRetry property is set
Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Whether a secure string should be used or not.
The Config object with the property set
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Sets the ProxyUsername property
Value for the ProxyUsername property
this instance
Checks if ProxyUsername property is set
true if ProxyUsername property is set
Sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
ProxyPassword property
this instance
Checks if ProxyPassword property is set
true if ProxyPassword property is set
Gets Service Version
Gets and sets of the signatureMethod property.
Gets and sets of the SignatureVersion property.
Gets and sets of the UserAgent property.
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint or want to switch between https and http.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureStringForAwsSecretKey property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
This command is for doing regular PutObject requests.
The UploadPartResponse contains all the information about the
UploadPart method.
Gets and sets the part number specified for the part upload. This is needed when
completing the multipart upload.
Gets and sets the Entity tag returned when the part was uploaded. This is needed
when completing the multipart upload.
Gets and sets the Headers property.
The ListObjectsRequest contains the parameters used for the ListObjects operation.
Required Parameters: BucketName
Optional Parameters: Prefix, Marker, MaxKeys, Delimiter
Sets the BucketName property for this request.
This is the name of the S3 Bucket to list keys from.
The value that BucketName is set to
this instance
Checks if BucketName property is set
true if BucketName property is set
Sets the Prefix property for this request.
All keys matched will have this prefix.
The value that Prefix is set to
this instance
Checks if Prefix property is set
true if Prefix property is set
Sets the Marker property for this request.
All keys returned will be lexiographically after the marker.
the value that Marker is set to
this instance
Checks if Marker property is set
true if Marker property is set
Sets the MaxKeys property for this request.
Limits the result set of keys to MaxKeys.
the value that MaxKeys is set to
this instance
Checks if MaxKeys property is set
true if MaxKeys property is set
Sets the Delimiter property for this request.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
the value that Delimiter is set to.
this instance
Checks if Delimiter property is set
true if Delimiter property is set
Gets and sets the BucketName property.
This is the name of the S3 Bucket to list keys from.
Gets and sets the Prefix property.
All keys matched will have this prefix.
Gets and sets the Marker property.
All keys returned will be lexiographically after the marker.
Gets and sets the MaxKeys property.
Limits the result set of keys to MaxKeys.
Gets and sets the Delimiter property.
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection.
These rolled-up keys are not returned elsewhere in the response.
PartDetails is a container for elements related to a particular part. A response can contain
zero or more Part elements.
Gets and sets the part number identifying the part.
Gets and sets the date and time at which the part was uploaded.
Gets and sets the entity tag returned when the part was uploaded.
Gets and sets the size of the uploaded part data.
Wrap an XmltextReader for simulating an event stream.
Each Read() operation goes either to the next element or next attribute within
the current element. TestExpression() is used to match the current event
to an xpath expression. The general pattern looks like this:
UnmarshallerContext context = new UnmarshallerContext(xmlReader);
while (context.Read())
{
if (context.TestExpresion("path/to/element"))
{
myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context);
continue;
}
if (context.TestExpression("path/to/@attribute"))
myObject.MyComplexTypeMember = MyComplexTypeUnmarshaller.GetInstance().Unmarshall(context);
}
Wrap an XmlTextReader with state for event-based parsing of an XML stream.
XmlTextReader with the XML from a service response.
Reads to the next node in the XML document, and updates the context
accordingly.
True if a node was read, false if there are no more elements to read./
Returns the text contents of the current element being parsed.
The text contents of the current element being parsed.
Tests the specified expression against the current position in the XML
document
The pseudo-XPath expression to test.
True if the expression matches the current position in the document,
false otherwise.
Tests the specified expression against the current position in the XML
document being parsed, and restricts the expression to matching at the
specified stack depth.
The pseudo-XPath expression to test.
The depth in the stack representing where the expression must
start matching in order for this method to return true.
True if the specified expression matches the current position in
the XML document, starting from the specified depth.
Rewinds the context to the start of the XML document being parsed.
Returns the element depth of the parser's current position in the XML
document being parsed.
The XmlNodeType of the current event. Will be one of
Element, EndElement, or Attribute during parsing,
and None at the start and end.
True if NodeType is Attribute.
True if NodeType is Element.
True if NodeType is EndElement.
True if the context is at the start of the document.
ReservedDBInstance Unmarshaller
Response Unmarshaller for DescribeDBSnapshots operation
Response Unmarshaller for DeleteDBSecurityGroup operation
Response Unmarshaller for CreateDBInstance operation
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
Sets the ReservedDBInstanceId property
The value to set for the ReservedDBInstanceId property
this instance
Sets the ReservedDBInstancesOfferingId property
The value to set for the ReservedDBInstancesOfferingId property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the Duration property
The value to set for the Duration property
this instance
Sets the FixedPrice property
The value to set for the FixedPrice property
this instance
Sets the UsagePrice property
The value to set for the UsagePrice property
this instance
Sets the CurrencyCode property
The value to set for the CurrencyCode property
this instance
Sets the DBInstanceCount property
The value to set for the DBInstanceCount property
this instance
Sets the ProductDescription property
The value to set for the ProductDescription property
this instance
Sets the MultiAZ property
The value to set for the MultiAZ property
this instance
Sets the State property
The value to set for the State property
this instance
The unique identifier for the reservation.
The offering identifier.
The DB instance class for the reserved DB Instance.
The time the reservation started.
The duration of the reservation in seconds.
The fixed price charged for this reserved DB Instance.
The hourly price charged for this reserved DB Instance.
The currency code for the reserved DB Instance.
The number of reserved DB Instances.
The description of the reserved DB Instance.
Indicates if the reservation applies to Multi-AZ deployments.
The state of the reserved DB Instance.
Returns information about the RebootDBInstance response and response metadata.
Gets and sets the RebootDBInstanceResult property.
Contains the result of a successful invocation of the RebootDBInstance
action.
Contains a list of available options for a DB Instance This data type is used as a response element in the
DescribeOrderableDBInstanceOptions action.
Sets the Engine property
The value to set for the Engine property
this instance
Sets the EngineVersion property
The value to set for the EngineVersion property
this instance
Sets the DBInstanceClass property
The value to set for the DBInstanceClass property
this instance
Sets the LicenseModel property
The value to set for the LicenseModel property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Sets the MultiAZCapable property
The value to set for the MultiAZCapable property
this instance
Sets the ReadReplicaCapable property
The value to set for the ReadReplicaCapable property
this instance
The engine type of the orderable DB Instance.
The engine version of the orderable DB Instance.
The DB Instance Class for the orderable DB Instance
The license model for the orderable DB Instance.
A list of availability zones for the orderable DB Instance.
Indicates whether this orderable DB Instance is multi-AZ capable.
Indicates whether this orderable DB Instance can have a read replica.
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Adds elements to the Parameters collection
The values to add to the Parameters collection
this instance
Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.
Provides an identifier to allow retrieval of paginated results.
Contains a list of engine default parameters.
Container for the parameters to the DescribeEngineDefaultParameters operation.
Returns the default engine and system parameter information for the specified database engine.
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
The name of the DB Parameter Group Family.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
An optional marker provided in the previous DescribeDBInstances request. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords.
The results from the DeleteDBSnapshot action.
Gets and sets the DeleteDBSnapshotResult property.
Contains the result of a successful invocation of the DeleteDBSnapshot
action.
Container for the parameters to the DeleteDBParameterGroup operation.
Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
NOTE: The specified database parameter group cannot be associated with any DB Instances.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
The name of the DB Parameter Group. Constraints: - Must be the name of an existing DB Parameter Group
- You cannot delete a
default DB Parameter Group
AmazonRDS exception
Constructs a new DBSnapshotAlreadyExistsException with the specified error
message.
Describes the error encountered.
AmazonRDS exception
Constructs a new DBInstanceNotFoundException with the specified error
message.
Describes the error encountered.
Response Unmarshaller for CancelJob operation
Cancel Job Request Marshaller
Returns information about the UpdateUser response metadata.
The UpdateUser operation has a void result type.
ListUsersResult Unmarshaller
ListGroupsForUserResult Unmarshaller
Response Unmarshaller for ListGroupPolicies operation
Response Unmarshaller for ListAccessKeys operation
List Access Keys Request Marshaller
GetGroupPolicyResult Unmarshaller
Response Unmarshaller for GetAccountSummary operation
Delete Login Profile Request Marshaller
Container for the parameters to the ListSigningCertificates operation.
Returns information about the signing certificates associated
with the specified User. If there are none, the action returns an
empty list. Although each User is limited to a small
number of signing certificates, you can still paginate the results
using the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is
determined implicitly based on the AWS Access Key ID used to sign the
request. Because this action works for access keys under the AWS
Account, this API can be used to manage root credentials even if the
AWS Account has no associated Users.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The name of the User.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of certificate IDs you want in the response. If there are additional
certificate IDs beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Returns information about the GetUserResult response and response metadata.
Gets and sets the GetUserResult property.
Contains the result of a successful invocation of the GetUser action.
Container for the parameters to the GetServerCertificate operation.
Retrieves information about the specified server
certificate.
Sets the ServerCertificateName property
The value to set for the ServerCertificateName property
this instance
The name of the server certificate you want to retrieve information about.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Container for the parameters to the GetLoginProfile operation.
Retrieves the login profile for the specified User.
Sets the UserName property
The value to set for the UserName property
this instance
Name of the User whose login profile you want to retrieve.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Returns information about the DeleteSigningCertificate response metadata.
The DeleteSigningCertificate operation has a void result type.
Returns information about the DeleteServerCertificate response metadata.
The DeleteServerCertificate operation has a void result type.
Container for the parameters to the DeleteGroupPolicy operation.
Deletes the specified policy that is associated with the
specified group.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Name of the group the policy is associated with.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the policy document to delete.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
JobFlowInstancesDetail Unmarshaller
AddInstanceGroupsResult Unmarshaller
Modify an instance group size.
Sets the InstanceGroupId property
The value to set for the InstanceGroupId property
this instance
Sets the InstanceCount property
The value to set for the InstanceCount property
this instance
Unique ID of the instance group to expand or shrink.
Constraints:
-
Length
0 - 256
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Target size for the instance group.
SetLoadBalancerPoliciesOfListenerResult Unmarshaller
SetLoadBalancerListenerSSLCertificateResult Unmarshaller
DescribeInstanceHealthResult Unmarshaller
AmazonElasticLoadBalancing exception
Constructs a new ListenerNotFoundException with the specified error
message.
Describes the error encountered.
Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.
Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.
In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be
provided.
Default constructor for a new DeregisterInstancesFromLoadBalancerRequest object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new DeregisterInstancesFromLoadBalancerRequest object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of EC2 instance IDs consisting of all instances to be deregistered.
Sets the LoadBalancerName property
The value to set for the LoadBalancerName property
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
Adds elements to the Instances collection
The values to add to the Instances collection
this instance
The name associated with the LoadBalancer. The name must be unique within the client AWS account.
A list of EC2 instance IDs consisting of all instances to be deregistered.
Container for the parameters to the ValidateConfigurationSettings operation.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are
valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option
values.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
Adds elements to the OptionSettings collection
The values to add to the OptionSettings collection
this instance
The name of the application that the configuration template or environment belongs to.
Constraints:
-
Length
1 - 100
The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name.
Constraints:
-
Length
1 - 100
The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name.
Constraints:
-
Length
4 - 23
A list of the options and desired values to evaluate.
Update Configuration Template Request Marshaller
Terminate Environment Request Marshaller
OptionRestrictionRegex Unmarshaller
EventDescription Unmarshaller
EnvironmentDescription Unmarshaller
Describe Applications Request Marshaller
Response Unmarshaller for CreateEnvironment operation
ConfigurationSettingsDescription Unmarshaller
AmazonElasticBeanstalk exception
Constructs a new TooManyConfigurationTemplatesException with the specified error
message.
Describes the error encountered.
Container for the parameters to the TerminateEnvironment operation.
Terminates the specified environment.
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the TerminateResources property
The value to set for the TerminateResources property
this instance
The ID of the environment to terminate.
The name of the environment to terminate.
Constraints:
-
Length
4 - 23
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the
environment. false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources
continue to operate. - true: The specified environment as well as the associated AWS resources, such
as Auto Scaling group and LoadBalancer, are terminated.
- false: AWS Elastic Beanstalk resource management is removed from
the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid
Values: true | false
AmazonElasticBeanstalk exception
Constructs a new InvalidParameterValueException with the specified error
message.
Describes the error encountered.
Describes the properties of an environment.
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the SolutionStackName property
The value to set for the SolutionStackName property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the EndpointURL property
The value to set for the EndpointURL property
this instance
Sets the CNAME property
The value to set for the CNAME property
this instance
Sets the DateCreated property
The value to set for the DateCreated property
this instance
Sets the DateUpdated property
The value to set for the DateUpdated property
this instance
Sets the Status property
The value to set for the Status property
this instance
Sets the Health property
The value to set for the Health property
this instance
Sets the Resources property
The value to set for the Resources property
this instance
The name of this environment.
Constraints:
-
Length
4 - 23
The ID of this environment.
The name of the application associated with this environment.
Constraints:
-
Length
1 - 100
The application version deployed in this environment.
Constraints:
-
Length
1 - 100
The name of the SolutionStack deployed with this environment.
Constraints:
-
Length
0 - 100
The name of the configuration template used to originally launch this environment.
Constraints:
-
Length
1 - 100
Describes this environment.
Constraints:
-
Length
0 - 200
The URL to the LoadBalancer for this environment.
The URL to the CNAME for this environment.
Constraints:
-
Length
1 - 255
The creation date for this environment.
The last modified date for this environment.
The current operational status of the environment: - Launching: Environment is in the process of initial deployment.
- Updating: Environment is in the process of updating its configuration settings or application version.
- Ready:
Environment is available to have an action performed on it, such as update or terminate.
- Terminating: Environment is in
the shut-down process.
- Terminated: Environment is not running.
Constraints:
-
Allowed Values
Launching, Updating, Ready, Terminating, Terminated
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working. Yellow: Indicates that
something is wrong, the application might not be available, but the instances appear running. Green:
Indicates the environment is healthy and fully functional. - Red: Indicates the environment is not
responsive. Occurs when three or more consecutive failures occur for an environment.
- Yellow: Indicates that something is
wrong. Occurs when two consecutive failures occur for an environment.
- Green: Indicates the environment is healthy and
fully functional.
- Grey: Default health for a new environment. The environment is not fully launched and health checks have
not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default:
Grey
Constraints:
-
Allowed Values
Green, Yellow, Red, Grey
The description of the AWS resources used by this environment.
Container for the parameters to the DescribeEvents operation.
Returns list of event descriptions matching criteria up to the last 6 weeks. NOTE: This action returns the most
recent 1,000 events from the specified NextToken.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the TemplateName property
The value to set for the TemplateName property
this instance
Sets the EnvironmentId property
The value to set for the EnvironmentId property
this instance
Sets the EnvironmentName property
The value to set for the EnvironmentName property
this instance
Sets the RequestId property
The value to set for the RequestId property
this instance
Sets the Severity property
The value to set for the Severity property
this instance
Sets the StartTime property
The value to set for the StartTime property
this instance
Sets the EndTime property
The value to set for the EndTime property
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
Constraints:
-
Length
1 - 100
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
Constraints:
-
Length
1 - 100
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
Constraints:
-
Length
1 - 100
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
Constraints:
-
Length
4 - 23
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
If specified, limits the events returned from this call to include only those with the specified severity or higher.
Constraints:
-
Allowed Values
TRACE, DEBUG, INFO, WARN, ERROR, FATAL
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
Pagination token. If specified, the events return the next batch of results.
Returns information about the DescribeConfigurationSettingsResult response and response metadata.
Gets and sets the DescribeConfigurationSettingsResult property.
The results from a request to change the configuration settings of an environment.
Container for the parameters to the CreateApplicationVersion operation.
Creates an application version for the specified application. NOTE:Once you create an application version with a
specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an
exception when you attempt to launch an environment from the application version.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Sets the VersionLabel property
The value to set for the VersionLabel property
this instance
Sets the Description property
The value to set for the Description property
this instance
Sets the SourceBundle property
The value to set for the SourceBundle property
this instance
Sets the AutoCreateApplication property
The value to set for the AutoCreateApplication property
this instance
The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an
InvalidParameterValue error.
Constraints:
-
Length
1 - 100
A label identifying this version. Constraint: Must be unique per application. If an application version already exists with this label for
the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Constraints:
-
Length
1 - 100
Describes this version.
Constraints:
-
Length
0 - 200
The Amazon S3 bucket and key that identify the location of the source bundle for this version. If data found at the Amazon S3 location
exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If not
specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key)
or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.
Determines how the system behaves if the specified application for this version does not already exist:
true: Automatically creates the specified application for this version if it does not already exist.
false: Returns an InvalidParameterValue if the specified application for this version does not already exist.
- true : Automatically creates the specified application for this release if it does not already exist.
- false : Throws an InvalidParameterValue if the specified application for this release does not already exist.
Default: false Valid Values: true | false
Returns information about the CreateApplicationResult response and response metadata.
Gets and sets the CreateApplicationResult property.
Result message containing a single description of an application.
Stops an instance that uses an Amazon EBS volume as its root device.
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.
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.
Performing this operation on an instance that
uses an instance store as its
root device returns
an error.
Sets the InstanceId property
The instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the Force property
Forces the instance to stop. The instance will
not have an opportunity to flush file system caches nor file
system meta data. If you use this option, you must perform file
system check and repair procedures. This option is not
recommended for Windows instances.
this instance
Checks if Force property is set
true if Force property is set
Gets and sets the InstanceId property.
The instance ID.
Gets and sets the Force property.
Forces the instance to stop. The instance will
not have an opportunity to flush file system caches nor file
system meta data. If you use this option, you must perform file
system check and repair procedures. This option is not
recommended for Windows instances.
Starts an instance that uses an Amazon EBS volume
as its root device.
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.
Sets the InstanceId property
The instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
The instance ID.
Launches a specified number of instances of an
AMI for which you have
permissions.
If Amazon EC2 cannot launch the
minimum number AMIs you request, no
instances will be launched. If
there is insufficient capacity to
launch the
maximum number of AMIs
you request, Amazon EC2 launches the minimum
number specified for
each AMI and allocate the remaining available
instances using round robin.
In the following example, Libby generates a request to
launch two images (database and web_server):
Libby runs the RunInstances operation to launch database instances
(min. 10, max. 15) and web_server instances (min. 30, max. 40).
Because there are currently 30 instances available and Libby needs a
minimum of 40, no instances are launched.
Libby adjusts the number of instances she needs and runs the
RunInstances operation to launch database
instances (min. 5, max. 10) and web_server
instances (min. 20, max. 40).
Amazon EC2 launches the minimum number of instances for each
AMI (5 database, 20 web_server).
The remaining 5 instances are
allocated using round robin.
Libby adjusts the number of instances
she needs and runs the RunInstances
operation again to launch
database instances (min. 5, max. 10) and
web_server instances (min.
20, max. 40).
Note - every instance is launched in a security group
(created using the CreateSecurityGroup operation.)
You can provide
an optional key pair ID for each image in the launch request
(created using the CreateKeyPair operation). All instances that
are created from images that use this key pair will have access to
the associated public key at boot. You can use this key to provide
secure access to an instance of
an image on a per-instance basis.
Amazon EC2 public images use this
feature to provide secure access
without passwords.
Important - launching public images without a
key pair ID will leave them
inaccessible.
The public key material is
made available to the instance at boot
time by placing it in the
openssh_id.pub file on a logical device that is exposed
to the instance as /dev/sda2 (the instance store). The format of this
file is suitable
for use as an entry within ~/.ssh/authorized_keys
(the OpenSSH format).
This can be done at boot (e.g., as part of
rc.local) allowing for secure access
without passwords.
Optional user data can be provided in the launch request. All instances that
collectively comprise the launch request have access to this data.
For more information, go the Amazon Elastic Compute Cloud Developer
Guide.
Note - if any of the AMIs have a product code attached for
which the user has not subscribed, the RunInstances call will fail.
Important - we strongly recommend using the 2.6.18 Xen stock
kernel with High-CPU and High-Memory instances. Although the
default Amazon EC2
kernels will work, the new kernels provide
greater stability and performance
for these instance types. For more
information about kernels, go the Amazon
Elastic Compute Cloud
Developer Guide
Sets the ImageId property
Unique ID of a machine image,
this instance
Checks if ImageId property is set
true if ImageId property is set
Sets the MinCount property
Minimum number of instances to launch. If the
value is more than Amazon
EC2 can launch, no instances are launched at all.
Constraints: Between 1 and the maximum number
allowed for your account (default: 20).
this instance
Checks if MinCount property is set
true if MinCount property is set
Sets the MaxCount property
Maximum number of instances to launch. If the
value is more than Amazon
EC2 can launch, the largest possible
number above minCount will be launched instead.
Constraints:
Between 1 and the maximum number allowed for your account
(default: 20).
this instance
Checks if MaxCount property is set
true if MaxCount property is set
Sets the KeyName property
The name of the key pair.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the SecurityGroup property
Names of the security group.
this instance
Checks if SecurityGroup property is set
true if SecurityGroup property is set
Sets the SecurityGroupId property
IDs of the security group.
this instance
Checks if SecurityGroupId property is set
true if SecurityGroupId property is set
Sets the UserData property
MIME, Base64-encoded user data.
this instance
Checks if UserData property is set
true if UserData property is set
Sets the InstanceType property
Specifies the instance type.
Valid Values:
m1.small | m1.large | m1.xlarge | c1.medium |
c1.xlarge |
m2.2xlarge | m2.4xlarge
Default: m1.small
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the Placement property
Specifies the placement constraints.
this instance
Checks if Placement property is set
true if Placement property is set
Sets the KernelId property
The ID of the kernel with which to launch the
instance.
this instance
Checks if KernelId property is set
true if KernelId property is set
Sets the RamdiskId property
The ID of the RAM disk with which to launch
the instance. Some kernels
require additional drivers at launch.
Check the kernel requirements for
information on whether you need
to specify a RAM disk. To find kernel
requirements, go to the
Resource Center and search for the
kernel ID.
this instance
Checks if RamdiskId property is set
true if RamdiskId property is set
Sets the BlockDeviceMapping property
Block device mapping.
this instance
Checks if BlockDeviceMapping property is set
true if BlockDeviceMapping property is set
Sets the Monitoring property
Enables monitoring for the instance.
this instance
Checks if Monitoring property is set
true if Monitoring property is set
Sets the SubnetId property
Specifies the subnet ID within which to launch
the instance(s) for
Amazon Virtual Private Cloud.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Sets the AdditionalInfo property
Specifies additional information to make
available to the instance(s)
this instance
Checks if AdditionalInfo property is set
true if AdditionalInfo property is set
Sets the DisableApiTermination property
Specifies whether the instance can be
terminated using the APIs. You must modify this attribute before
you can terminate any "locked" instances from the APIs.
this instance
Checks if DisableApiTermination property is set
true if DisableApiTermination property is set
Sets the InstanceInitiatedShutdownBehavior property
Specifies whether the instance's Amazon EBS
volumes are stopped or terminated when the instance is shut
down.
this instance
Checks if InstanceInitiatedShutdownBehavior property is set
true if InstanceInitiatedShutdownBehavior property is set
Sets the License property
Specifies active licenses in use and attached
to an Amazon EC2 instance.
this instance
Checks if License property is set
true if License property is set
Sets the PrivateIpAddress property
If you're using Amazon Virtual Private Cloud,
you can optionally use this
parameter to assign the instance a
specific available IP address from the
subnet.
this instance
Checks if PrivateIpAddress property is set
true if PrivateIpAddress property is set
Sets the ClientToken property
ClientToken property
this instance
Checks if ClientToken property is set
true if ClientToken property is set
Sets the Hypervisor property
Hypervisor property
this instance
Checks if Hypervisor property is set
true if Hypervisor property is set
Gets and sets the ImageId property.
Unique ID of a machine image,
Gets and sets the MinCount property.
Minimum number of instances to launch. If the
value is more than Amazon
EC2 can launch, no instances are launched at all.
Constraints: Between 1 and the maximum number
allowed for your account (default: 20).
Gets and sets the MaxCount property.
Maximum number of instances to launch. If the
value is more than Amazon
EC2 can launch, the largest possible
number above minCount will be launched instead.
Constraints:
Between 1 and the maximum number allowed for your account
(default: 20).
Gets and sets the KeyName property.
The name of the key pair.
Gets and sets the SecurityGroup property.
Names of the security group.
Gets and sets the SecurityGroupId property.
IDs of the security group.
Gets and sets the UserData property.
MIME, Base64-encoded user data.
Gets and sets the InstanceType property.
Specifies the instance type.
Valid Values:
m1.small | m1.large | m1.xlarge | c1.medium |
c1.xlarge |
m2.2xlarge | m2.4xlarge
Default: m1.small
Gets and sets the Placement property.
Specifies the placement constraints.
Gets and sets the KernelId property.
The ID of the kernel with which to launch the
instance.
Gets and sets the RamdiskId property.
The ID of the RAM disk with which to launch
the instance. Some kernels
require additional drivers at launch.
Check the kernel requirements for
information on whether you need
to specify a RAM disk. To find kernel
requirements, go to the
Resource Center and search for the
kernel ID.
Gets and sets the BlockDeviceMapping property.
Block device mapping.
Gets and sets the Monitoring property.
Enables monitoring for the instance.
Gets and sets the SubnetId property.
Specifies the subnet ID within which to launch
the instance(s) for
Amazon Virtual Private Cloud.
Gets and sets the AdditionalInfo property.
Specifies additional information to make
available to the instance(s)
Gets and sets the DisableApiTermination property.
Specifies whether the instance can be
terminated using the APIs. You must modify this attribute before
you can terminate any "locked" instances from the APIs.
Gets and sets the InstanceInitiatedShutdownBehavior property.
Specifies whether the instance's Amazon EBS
volumes are stopped or terminated when the instance is shut
down.
Gets and sets the License property.
Specifies active licenses in use and attached
to an Amazon EC2 instance.
Gets and sets the PrivateIpAddress property.
If you're using Amazon Virtual Private Cloud,
you can optionally use this
parameter to assign the instance a
specific available IP address from the
subnet.
Gets and sets the ClientToken property.
Gets and sets the Hypervisor property.
Response Metadata
Sets the RequestId property
Request Id
this instance
Checks if RequestId property is set
true if RequestId property is set
Gets and sets the RequestId property.
Request Id
Resets permission settings for the specified
snapshot
Sets the SnapshotId property
The ID of the snapshot.
this instance
Checks if SnapshotId property is set
true if SnapshotId property is set
Sets the Attribute property
Resets the create volume permissions of the
snapshot.
this instance
Checks if Attribute property is set
true if Attribute property is set
Gets and sets the SnapshotId property.
The ID of the snapshot.
Gets and sets the Attribute property.
Resets the create volume permissions of the
snapshot.
Request to create a Spot Instance request.
Sets the SpotPrice property
Specifies the maximum price you will pay to
launch one or more Spot Instances.
this instance
Checks if SpotPrice property is set
true if SpotPrice property is set
Sets the InstanceCount property
The maximum number of Spot Instances to launch. Default - 1.
this instance
Checks if InstanceCount property is set
true if InstanceCount property is set
Sets the Type property
The instance type. Valid values:
m1.small|m1.large|m1.xlarge|c1.medium|c1.xlarge|m2.2xlarge|m4.4xlarge.
Default - m1.small.
this instance
Checks if Type property is set
true if Type property is set
Sets the ValidFrom property
Start date of the request. If this is a one-time request,
the request remains active until all instances
launch, the request expires, or the request is canceled. If the
request is persistent, it remains active until it expires or
is canceled.
Default: Request is effective immediately
this instance
Checks if ValidFrom property is set
true if ValidFrom property is set
Sets the ValidUntil property
End date of the request. If this is a one-time request,
the request remains active until all instances launch,
the request expires, or the request is canceled. If the
request is persistent, it remains active until it expires or
is canceled.
Default: Request remains open until criteria for closing are met
this instance
Checks if ValidUntil property is set
true if ValidUntil property is set
Sets the LaunchGroup property
Specifies the instance launch group. Launch
groups are Spot Instances that launch together and terminate
together.
Default: Instances are launched and terminated individually
this instance
Checks if LaunchGroup property is set
true if LaunchGroup property is set
Sets the AvailabilityZoneGroup property
Specifies the Availability Zone group. If you specify
the same Availability Zone group for all Spot Instance
requests, all Spot Instances are launched in the same
Availability Zone.
Default: Instances are launched in any available Availability Zone.
this instance
Checks if AvailabilityZoneGroup property is set
true if AvailabilityZoneGroup property is set
Sets the LaunchSpecification property
Specifies additional launch instance information.
this instance
Checks if LaunchSpecification property is set
true if LaunchSpecification property is set
Gets and sets the SpotPrice property.
Specifies the maximum price you will pay to
launch one or more Spot Instances.
Gets and sets the InstanceCount property.
The maximum number of Spot Instances to launch. Default - 1.
Gets and sets the Type property.
The instance type. Valid values:
m1.small|m1.large|m1.xlarge|c1.medium|c1.xlarge|m2.2xlarge|m4.4xlarge.
Default - m1.small.
Gets and sets the ValidFrom property.
Start date of the request. If this is a one-time request,
the request remains active until all instances
launch, the request expires, or the request is canceled. If the
request is persistent, it remains active until it expires or
is canceled.
Default: Request is effective immediately
Gets and sets the ValidUntil property.
End date of the request. If this is a one-time request,
the request remains active until all instances launch,
the request expires, or the request is canceled. If the
request is persistent, it remains active until it expires or
is canceled.
Default: Request remains open until criteria for closing are met
Gets and sets the LaunchGroup property.
Specifies the instance launch group. Launch
groups are Spot Instances that launch together and terminate
together.
Default: Instances are launched and terminated individually
Gets and sets the AvailabilityZoneGroup property.
Specifies the Availability Zone group. If you specify
the same Availability Zone group for all Spot Instance
requests, all Spot Instances are launched in the same
Availability Zone.
Default: Instances are launched in any available Availability Zone.
Gets and sets the LaunchSpecification property.
Specifies additional launch instance information.
Purchase Reserved Instances Offering Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if PurchaseReservedInstancesOfferingResult property is set
true if PurchaseReservedInstancesOfferingResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the PurchaseReservedInstancesOfferingResult property.
Purchase Reserved Instances Offering Result
Sets the NetworkAclId property
The network ACL's ID.
this instance
Checks if NetworkAclId property is set
true if NetworkAclId property is set
Sets the VpcId property
The ID of the VPC the network ACL is in.
this instance
Checks if VpcId property is set
true if VpcId property is set
Sets the Default property
Whether this is the default network ACL in the VPC.
this instance
Checks if Default property is set
true if Default property is set
Sets the Entries property
A list of entries (rules) in the network ACL.
this instance
Checks if Entries property is set
true if Entries property is set
Sets the Associations property
A list of associations between the network ACL and one or more
subnets.
this instance
Checks if Associations property is set
true if Associations property is set
Sets the Tag property
A list of tags for the NetworkAcl.
this instance
Checks if Tag property is set
true if Tag property is set
Gets and sets the NetworkAclId property.
The network ACL's ID.
Gets and sets the VpcId property.
The ID of the VPC the network ACL is in.
Gets and sets the Default property.
Whether this is the default network ACL in the VPC.
Gets and sets the Entries property.
A list of entries (rules) in the network ACL.
Gets and sets the Associations property.
A list of associations between the network ACL and one or more
subnets.
Gets and sets the Tag property.
A list of tags for the NetworkAcl.
Monitoring
Sets the MonitoringState property
State of monitoring for the instance. Valid
Values:
monitoring-enabled (enabled)
| monitoring-pending
(pending) | monitoring-disabled (disabled)
this instance
Checks if MonitoringState property is set
true if MonitoringState property is set
Gets and sets the MonitoringState property.
State of monitoring for the instance. Valid
Values:
monitoring-enabled (enabled)
| monitoring-pending
(pending) | monitoring-disabled (disabled)
Instance state change
Sets the InstanceId property
Instance ID
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the CurrentState property
Current state
this instance
Checks if CurrentState property is set
true if CurrentState property is set
Sets the PreviousState property
Previous state
this instance
Checks if PreviousState property is set
true if PreviousState property is set
Gets and sets the InstanceId property.
Instance ID
Gets and sets the CurrentState property.
Current state
Gets and sets the PreviousState property.
Previous state
The Response for the
ImportVolume operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if ImportVolumeResult property is set
true if ImportVolumeResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the ImportVolumeResult property.
Import Volume Result
Creates a new import volume task using metadata from the specified disk image.
Sets the AvailabilityZone property
Availability Zone where the resulting Amazon EBS volume will reside.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Image property
Details about the image.
this instance
Checks if Image property is set
true if Image property is set
Sets the Description property
Optional description of the volume being imported.
this instance
Checks if Description property is set
true if Description property is set
Sets the Volume property
Details about the volume.
this instance
Checks if Volume property is set
true if Volume property is set
Gets and sets the AvailabilityZone property.
Availability Zone where the resulting Amazon EBS volume will reside.
Gets and sets the Image property.
Details about the image.
Gets and sets the Description property.
Optional description of the volume being imported.
Gets and sets the Volume property.
Details about the volume.
The Response for the
DisassociateRouteTable operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Describe Vpcs Result
Checks if Vpc property is set
true if Vpc property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Vpc property.
List of VPCs
Describe Security Groups Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeSecurityGroupsResult property is set
true if DescribeSecurityGroupsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeSecurityGroupsResult property.
Describe Security Groups Result
Returns information about key pairs available to
you. If you specify key pairs, information
about those key pairs is returned. Otherwise, information for all
registered key pairs is returned.
Sets the KeyName property
Key pair to describe.
this instance
Checks if KeyName property is set
true if KeyName property is set
Sets the Filter property
A list of filters used to match system-defined properties and user-defined tags associated with
the specified KeyPairs.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
this instance
Checks if Filter property is set
true if Filter property is set
Gets and sets the KeyName property.
Key pair to describe.
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified KeyPairs.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
The Response for the
DescribeConversionTasks operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeConversionTasksResult property is set
true if DescribeConversionTasksResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeConversionTasksResult property.
DescribeConversionTasks Result
Deletes an Amazon EBS volume that you own. For
more information about
Amazon EBS,
go to the Amazon Elastic Compute
Cloud Developer Guide.
Sets the VolumeId property
The ID of the volume to delete.
this instance
Checks if VolumeId property is set
true if VolumeId property is set
Gets and sets the VolumeId property.
The ID of the volume to delete.
Delete Security Group Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
The Response for the
DeleteNetworkAcl operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Delete Dhcp Options Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Creates a new route in a route table within a VPC. The route's target can be either a gateway attached
to the VPC or a NAT instance in the VPC.
When determining how to route traffic, we use the route with the most specific match. For example, let's
say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific,
so we use that route to determine where to target the traffic.
For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User
Guide.
Sets the RouteTableId property
The ID of the route table where the route will
be added.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the DestinationCidrBlock property
The CIDR address block used for the
destination match. For example: 0.0.0.0/0.
Routing decisions are based on the most
specific match.
this instance
Checks if DestinationCidrBlock property is set
true if DestinationCidrBlock property is set
Sets the GatewayId property
The ID of a gateway attached to your VPC.
this instance
Checks if GatewayId property is set
true if GatewayId property is set
Sets the InstanceId property
The ID of a NAT instance in your VPC.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the RouteTableId property.
The ID of the route table where the route will
be added.
Gets and sets the DestinationCidrBlock property.
The CIDR address block used for the
destination match. For example: 0.0.0.0/0.
Routing decisions are based on the most
specific match.
Gets and sets the GatewayId property.
The ID of a gateway attached to your VPC.
Gets and sets the InstanceId property.
The ID of a NAT instance in your VPC.
Create Key Pair Result
Checks if KeyPair property is set
true if KeyPair property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the KeyPair property.
Key Pair
The Cancel Spot Instance Requests Result.
Checks if CancelledSpotInstanceRequest property is set
true if CancelledSpotInstanceRequest property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the CancelledSpotInstanceRequest property.
The list of cancelled Spot Instance requests.
The Response for the
CancelConversionTask operation.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Availability Zone
Sets the ZoneName property
Name of the Availability Zone.
this instance
Checks if ZoneName property is set
true if ZoneName property is set
Sets the ZoneState property
State of the Availability Zone.
this instance
Checks if ZoneState property is set
true if ZoneState property is set
Sets the RegionName property
Name of the region.
this instance
Checks if RegionName property is set
true if RegionName property is set
Sets the Message property
The Availability Zone messages.
this instance
Checks if Message property is set
true if Message property is set
Gets and sets the ZoneName property.
Name of the Availability Zone.
Gets and sets the ZoneState property.
State of the Availability Zone.
Gets and sets the RegionName property.
Name of the region.
Gets and sets the Message property.
The Availability Zone messages.
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 if you want to disassociate the route table
from the subnet later. A route table can be associated with multiple subnets.
Sets the RouteTableId property
The ID of the route table.
this instance
Checks if RouteTableId property is set
true if RouteTableId property is set
Sets the SubnetId property
The ID of the subnet.
this instance
Checks if SubnetId property is set
true if SubnetId property is set
Gets and sets the RouteTableId property.
The ID of the route table.
Gets and sets the SubnetId property.
The ID of the subnet.
Activates a license.
Sets the LicenseId property
Specifies the ID for the specific license to
activate against.
this instance
Checks if LicenseId property is set
true if LicenseId property is set
Sets the Capacity property
Specifies the additional number of licenses to
activate.
this instance
Checks if Capacity property is set
true if Capacity property is set
Gets and sets the LicenseId property.
Specifies the ID for the specific license to
activate against.
Gets and sets the Capacity property.
Specifies the additional number of licenses to
activate.
Configuration for accessing Amazon EC2 service
Sets the SignatureMethod property
SignatureMethod property
this instance
Checks if SignatureMethod property is set
true if SignatureMethod property is set
Sets the SignatureVersion property
SignatureVersion property
this instance
Checks if SignatureVersion property is set
true if SignatureVersion property is set
Sets the UserAgent property
UserAgent property
this instance
Checks if UserAgent property is set
true if UserAgent property is set
Sets the ServiceURL property
ServiceURL property
this instance
Checks if ServiceURL property is set
true if ServiceURL property is set
Sets the ProxyHost property
ProxyHost property
this instance
Checks if ProxyHost property is set
true if ProxyHost property is set
Sets the ProxyPort property
ProxyPort property
this instance
Checks if ProxyPort property is set
true if ProxyPort property is set
Sets the MaxErrorRetry property
MaxErrorRetry property
this instance
Checks if MaxErrorRetry property is set
true if MaxErrorRetry property is set
Sets the UseSecureString property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Whether a secure string should be used or not.
The Config object with the property set
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Sets the ProxyUsername property
Value for the ProxyUsername property
this instance
Checks if ProxyUsername property is set
true if ProxyUsername property is set
Sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
ProxyPassword property
this instance
Checks if ProxyPassword property is set
true if ProxyPassword property is set
Gets Service Version
Gets and sets of the signatureMethod property.
Gets and sets of the SignatureVersion property.
Gets and sets of the UserAgent property.
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint or want to switch between https and http.
Gets and sets of the ProxyHost property.
Gets and sets of the ProxyPort property.
Gets and sets of the MaxErrorRetry property.
Gets and Sets the UseSecureStringForAwsSecretKey property.
By default, the AWS Secret Access Key is stored
in a SecureString (true) - this is one of the secure
ways to store a secret provided by the .NET Framework.
But, the use of SecureStrings is not supported in Medium
Trust Windows Hosting environments. If you are building an
ASP.NET application that needs to run with Medium Trust,
set this property to false, and the client will
not save your AWS Secret Key in a secure string. Changing
the default to false can result in the Secret Key being
vulnerable; please use this property judiciously.
Storing the AWS Secret Access Key is not
recommended unless absolutely necessary.
Gets and sets the ProxyUsername property.
Used in conjunction with the ProxyPassword
property to authenticate requests with the
specified Proxy server.
Gets and sets the ProxyPassword property.
Used in conjunction with the ProxyUsername
property to authenticate requests with the
specified Proxy server.
If this property isn't set, String.Empty is used as
the proxy password. This property isn't
used if ProxyUsername is null or empty.
Response Unmarshaller for SetAlarmState operation
Returns information about the PutMetricData response metadata.
The PutMetricData operation has a void result type.
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. When this operation creates an alarm,
the alarm state is immediately set to INSUFFICIENT_DATA . The
alarm is evaluated and its StateValue is set appropriately.
Any actions associated with the StateValue is then executed.
NOTE: When updating an existing alarm, its
StateValue is left unchanged.
Sets the AlarmName property
The value to set for the AlarmName property
this instance
Sets the AlarmDescription property
The value to set for the AlarmDescription property
this instance
Sets the ActionsEnabled property
The value to set for the ActionsEnabled property
this instance
Adds elements to the OKActions collection
The values to add to the OKActions collection
this instance
Adds elements to the OKActions collection
The values to add to the OKActions collection
this instance
Adds elements to the AlarmActions collection
The values to add to the AlarmActions collection
this instance
Adds elements to the AlarmActions collection
The values to add to the AlarmActions collection
this instance
Adds elements to the InsufficientDataActions collection
The values to add to the InsufficientDataActions collection
this instance
Adds elements to the InsufficientDataActions collection
The values to add to the InsufficientDataActions collection
this instance
Sets the MetricName property
The value to set for the MetricName property
this instance
Sets the Namespace property
The value to set for the Namespace property
this instance
Sets the Statistic property
The value to set for the Statistic property
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Adds elements to the Dimensions collection
The values to add to the Dimensions collection
this instance
Sets the Period property
The value to set for the Period property
this instance
Sets the Unit property
The value to set for the Unit property
this instance
Sets the EvaluationPeriods property
The value to set for the EvaluationPeriods property
this instance
Sets the Threshold property
The value to set for the Threshold property
this instance
Sets the ComparisonOperator property
The value to set for the ComparisonOperator property
this instance
The descriptive name for the alarm. This name must be unique within the user's AWS account
Constraints:
-
Length
1 - 255
The description for the alarm.
Constraints:
-
Length
0 - 255
Indicates whether or not actions should be executed during any changes to the alarm's state.
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
Constraints:
-
Length
0 - 5
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an
Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
Constraints:
-
Length
0 - 5
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto
Scaling policy.
Constraints:
-
Length
0 - 5
The name for the alarm's associated metric.
Constraints:
-
Length
1 - 255
The namespace for the alarm's associated metric.
Constraints:
-
Length
1 - 255
-
Pattern
[^:].*
The statistic to apply to the alarm's associated metric.
Constraints:
-
Allowed Values
SampleCount, Average, Sum, Minimum, Maximum
The dimensions for the alarm's associated metric.
Constraints:
-
Length
0 - 10
The period in seconds over which the specified statistic is applied.
Constraints:
-
Range
60 -
The unit for the alarm's associated metric.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
The number of periods over which data is compared to the specified threshold.
Constraints:
-
Range
1 -
The value against which the specified statistic is compared.
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is
used as the first operand.
Constraints:
-
Allowed Values
GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
The Signer complex type specifies an AWS accounts that has permission to create signed URLs
for private content. The Accounts that have signing privileges are specified in the
DistributionConfig complex type and can be set using the SetDistributionConfig CloudFront
operation. A signer can be:
- Yourself (you must explicitly give yourself permission).
- An AwsAccountNumber for each AWS account (other than your own) that you is given signing
authority. The account number has no dashes.
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.
Checks if KeyPairId property is set
true if KeyPairId property is set
Checks if AwsAccountNumber property is set
true if AwsAccountNumber property is set
Gets and Sets the KeyPairId property.
A list of the KeyPairId for the AWS account
that has URL signing authority.
Gets and sets the Self property.
Whether this Signer specifies "your" account.
Gets and sets the AwsAccountNumber property.
The SetOriginAccessIdentityConfigRequest contains the parameters used for the
SetOriginAccessIdentityConfig operation.
Required Parameters: Id
Required Parameters: OriginAccessIdentityConfig
Required Parameters: ETag of the Origin Access Identity.
This value can be retrieved via a call to GetOriginAccessIdentityInfo.
Sets the Id property for this request.
This is the Id of the CloudFront Origin Access Identity
that will be reconfigured by this request.
The value that Id is set to
the request with the Id set
Sets the OriginAccessIdentityConfig property for this request.
The value that OriginAccessIdentityConfig is set to
the request with the Configuration set
Checks if DistributionConfig property is set.
true if DistributionConfig property is set.
Sets the ETag property for this request.
This is the ETag of the CloudFront Origin Access Identity which will be reconfigured.
The value that ETag is set to
the request with the ETag set
Gets and sets the Id property.
Gets and Sets the OriginAccessIdentityConfig property.
The CloudFront Origin Access Identity's configuration will be modified
to reflect the values in this configuration object.
Gets and sets the ETag property. This value should be the ETag of the
Origin Access Identity.
The protocols allowed as a RequiredProtocol
by a CloudFront Distribution's configuration.
The HTTPS protocol
GetTemplateResult Unmarshaller
Response Unmarshaller for DescribeStackEvents operation
The Parameter data type.
Sets the ParameterKey property
The value to set for the ParameterKey property
this instance
Sets the ParameterValue property
The value to set for the ParameterValue property
this instance
The key associated with the parameter.
The value associated with the parameter.
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).
Sets the NextToken property
The value to set for the NextToken property
this instance
Adds elements to the StackStatusFilter collection
The values to add to the StackStatusFilter collection
this instance
Adds elements to the StackStatusFilter collection
The values to add to the StackStatusFilter collection
this instance
The output for a DescribeStackEvents action.
Adds elements to the StackEvents collection
The values to add to the StackEvents collection
this instance
Adds elements to the StackEvents collection
The values to add to the StackEvents collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
A list of StackEvents structures.
String that identifies the start of the next list of events, if there is one.
Constraints:
-
Length
1 - 1024
TerminateInstanceInAutoScalingGroupResult Unmarshaller
InstanceMonitoring Unmarshaller
Response Unmarshaller for DisableMetricsCollection operation
Describe Scaling Process Types Request Marshaller
Response Unmarshaller for DescribeAdjustmentTypes operation
Container for the parameters to the SuspendProcesses operation.
Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the
ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.
IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from
functioning properly. For more information about processes and their dependencies, see ProcessType. To resume processes that
have been suspended, use ResumeProcesses.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Adds elements to the ScalingProcesses collection
The values to add to the ScalingProcesses collection
this instance
Adds elements to the ScalingProcesses collection
The values to add to the ScalingProcesses collection
this instance
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The processes that you want to suspend or resume, which can include one or more of the following: - Launch
- Terminate
- HealthCheck
- ReplaceUnhealthy
- AZRebalance
- AlarmNotifications
- ScheduledActions
To suspend
all process types, omit this parameter.
This data type stores information about an scheduled update to an Auto Scaling group.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the ScheduledActionName property
The value to set for the ScheduledActionName property
this instance
Sets the ScheduledActionARN property
The value to set for the ScheduledActionARN property
this instance
Sets the Time property
The value to set for the Time property
this instance
Sets the MinSize property
The value to set for the MinSize property
this instance
Sets the MaxSize property
The value to set for the MaxSize property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
The name of the Auto Scaling group to be updated.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of this scheduled action.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of this scheduled action.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The time that the action is scheduled to occur. This value can be up to one month in the future.
The minimum size of the Auto Scaling group.
The maximum size of the Auto Scaling group.
The number of instances you prefer to maintain in your Auto Scaling group. The desired capacity must be no less than
ScheduledUpdateGroupAction$MinSize and no greater than ScheduledUpdateGroupAction$MaxSize.
Container for the parameters to the PutScalingPolicy operation.
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the
parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update
request.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the ScalingAdjustment property
The value to set for the ScalingAdjustment property
this instance
Sets the AdjustmentType property
The value to set for the AdjustmentType property
this instance
Sets the Cooldown property
The value to set for the Cooldown property
this instance
The name or ARN of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the policy you want to create or update.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The number of instances by which to scale. AdjustmentType determines the interpretation of this number (e.g., as an absolute number or as a
percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the
current capacity.
Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
The output of the DescribeMetricCollectionTypes action.
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Adds elements to the Metrics collection
The values to add to the Metrics collection
this instance
Adds elements to the Granularities collection
The values to add to the Granularities collection
this instance
Adds elements to the Granularities collection
The values to add to the Granularities collection
this instance
The list of Metrics collected.
A list of Granularities for the listed Metrics.
Container for the parameters to the DescribeLaunchConfigurations operation.
Returns a full description of the launch configurations given the specified names. If no names are specified, then the
full details of all launch configurations are returned.
Adds elements to the LaunchConfigurationNames collection
The values to add to the LaunchConfigurationNames collection
this instance
Adds elements to the LaunchConfigurationNames collection
The values to add to the LaunchConfigurationNames collection
this instance
Sets the NextToken property
The value to set for the NextToken property
this instance
Sets the MaxRecords property
The value to set for the MaxRecords property
this instance
A list of launch configuration names.
A string that marks the start of the next batch of returned results.
Constraints:
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The maximum number of launch configurations.
Constraints:
-
Range
1 - 50
Container for the parameters to the DeleteScheduledAction operation.
Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the ScheduledActionName property
The value to set for the ScheduledActionName property
this instance
The name of the Auto Scaling group
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the action you want to delete.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Returns a list of messages and metadata about the request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Information about the request provided by Amazon SQS.
Response Unmarshaller for SendEmail operation
Returns information about the SendEmailResult response and response metadata.
Gets and sets the SendEmailResult property.
Represents a unique message ID returned from a successful SendEmail request.
Represents the message to be sent, composed of a subject and a
body.
Default constructor for a new Message object. Callers should use the
properties or fluent setter (With...) methods to initialize this object after creating it.
Constructs a new Message object.
Callers should use the properties or fluent setter (With...) methods to
initialize any additional object members.
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
The message body.
Sets the Subject property
The value to set for the Subject property
this instance
Sets the Body property
The value to set for the Body property
this instance
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
The message body.
Provides a collection of static functions to:
1. Convert various values into strings that may be compared lexicographically
2. Decode a Base64 Encoded string
3. Decode an Amazon SimpleDB Attribute's properties
4. Decode an Amazon SimpleDB Item's properties and constituent Item(s)
Date format String, e.g. 2007-12-06T10:32:43.141-08:00
Encodes positive integer value into a string by zero-padding it up to the specified number of digits.
For example, the integer 123 encoded with a 6 digit maximum would be represented as 000123
positive integer to be encoded
maximum number of digits in the largest value in the data set
A string representation of the zero-padded integer
Encodes positive single-precision floating point value into a string by zero-padding it to the specified number of digits.
This function only zero-pads digits to the left of the decimal point.
For example, the value 123.456 encoded with a 6 digit maximum would be represented as 000123.456
positive floating point value to be encoded
maximum number of digits in the largest value in the data set
A string representation of the zero-padded floating point value
Encodes real integer value into a string by offsetting and zero-padding
number up to the specified number of digits. Use this encoding method if the data
range set includes both positive and negative values.
For example, the integer value -123 offset by 1000 with a maximum of 6 digits would be:
-123 + 1000, padded to 6 digits: 000877
integer to be encoded
maximum number of digits in the largest absolute value in the data set
offset value, has to be greater than absolute value of any negative number in the data set.
A string representation of the integer
Encodes real float value into a string by offsetting and zero-padding
number up to the specified number of digits. Use this encoding method if the data
range set includes both positive and negative values.
For example, the floating point value -123.456 offset by 1000 with
a maximum of 6 digits to the left, and 4 to the right would be:
0008765440
floating point value to be encoded
maximum number of digits left of the decimal point in the largest absolute value in the data set
maximum number of digits right of the decimal point in the largest absolute value in the data set, i.e. precision
offset value, has to be greater than absolute value of any negative number in the data set.
A string representation of the integer
Decodes zero-padded positive float value from the string representation
zero-padded string representation of the float value
original float value
Decodes zero-padded positive integer value from the string representation
zero-padded string representation of the integer
original integer value
Decodes float value from the string representation that was created by using encodeRealNumberRange(..) function.
string representation of the integer value
offset value that was used in the original encoding
original integer value
Decodes float value from the string representation that was created by using encodeRealNumberRange(..) function.
string representation of the integer value
maximum number of digits left of the decimal point in the largest absolute
value in the data set (must be the same as the one used for encoding).
offset value that was used in the original encoding
original float value
Encodes date value into string format that can be compared lexicographically
date value to be encoded
string representation of the date value
Decodes date value from the string representation created using encodeDate(..) function.
string representation of the date value
original date value
Decodes the base64 encoded properties of the Attribute.
The Name and/or Value properties of an Attribute can be base64 encoded.
The properties of this Attribute will be decoded
Decodes the base64 properties of every SimpleDB Attribute specified in
list of attributes specified as input.
The Attributes in this list will be decoded
Decodes the base64 encoded members of the Item if necessary.
The Name property of an Item can be base64 encoded.
This method also decodes any encoded properties of the Attributes
associated with the Input Item.
The Item to be decoded
Decodes the base64 encoded members of the Item List.
The Item List to be decoded
Returns the Base64 decoded version of the input string.
The Base64 encoded string
Decoded version of the Base64 input string
Gets the Current Date as an ISO8601 formatted Timestamp
ISO8601 formatted current timestamp String
The Select operation returns a set of Attributes for ItemNames that match the select expression. Select is similar to
the standard SQL SELECT statement. The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB
automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to
retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate next
token so you can get the next page of results.
Operations that run longer than 5 seconds return a time-out error response or a partial or empty result set. Partial
and empty result sets contains a next token which allow you to continue the operation from where it left off.
Responses larger than one megabyte return a partial result set.
Your application should not excessively retry queries that return RequestTimeout errors. If you receive too many
RequestTimeout errors, reduce the complexity of your query expression.
When designing your application, keep in mind that Amazon SimpleDB does not guarantee how attributes are ordered in
the returned response.
Sets the SelectExpression property
This section describes Select, a function that takes query expressions similar to the standard SQL SELECT statement.
See http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/UsingSelect.html for more information
on building expressions.
this instance
Checks if SelectExpression property is set
true if SelectExpression property is set
Sets the NextToken property
String that tells Amazon SimpleDB where to start the next list of item names.
this instance
Checks if NextToken property is set
true if NextToken property is set
Sets the ConsistentRead property
If set to true, this flag ensures that the most recently written data is
returned.
this instance
Checks if ConsistentRead property is set
true if ConsistentRead property is set
Gets and sets the SelectExpression property.
This section describes Select, a function that takes query expressions similar to the standard SQL SELECT statement.
See http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/UsingSelect.html for more information
on building expressions.
Gets and sets the NextToken property.
String that tells Amazon SimpleDB where to start the next list of item names.
Gets and sets the ConsistentRead property.
If set to true, this flag ensures that the most recently written data is
returned.
Information about the request provided by Amazon SimpleDB.
Sets the RequestId property
A unique ID for tracking the request.
this instance
Checks if RequestId property is set
true if RequestId property is set
Sets the BoxUsage property
The measure of machine utilization for this request. This does not include storage or transfer usage.
this instance
Checks if BoxUsage property is set
true if BoxUsage property is set
Gets and sets the RequestId property.
A unique ID for tracking the request.
Gets and sets the BoxUsage property.
The measure of machine utilization for this request. This does not include storage or transfer usage.
The GetBucketLoggingRequest contains the parameters used for the GetBucketLogging operation.
Required Parameters: BucketName
Sets the BucketName property for this request.
The logging config returned will be for this S3 Bucket.
The value that BucketName is set to
this instance
Checks if BucketName property is set.
true if BucketName property is set.
Gets and sets the BucketName property.
The InitiateMultipartUploadRequest contains the parameters used for the InitiateMultipartUpload method.
Required Parameters: BucketName, Key
Sets the BucketName property for this request.
This is the S3 Bucket where the S3 Object you are
creating gets put.
The value that BucketName is set to
The request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object you create.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the CannedACL property for this request.
If set, the S3 Object will have this CannedACL
permission. Please refer to
for
information on S3 Canned ACLs.
The Canned ACL to be set on the object
The request with the CannedACL set
Checks if the CannedACL property is set.
true if there is the CannedACL property is set.
Resets the CannedACL
Sets the ContentType property for this request.
This property defaults to "binary/octet-stream",
but if you require something else you can set this property.
the value the ContentType to be set to
The request with the ContentType set
Checks if ContentType property is set.
true if ContentType property is set.
Adds a key/value pair to the Metadata property for this request.
The S3 Object that you create will have this metadata associated
with it.
The key to associate with the object
The value for the key
The response with Metadata set.
Adds a set of key-value pairs to the request
The set of key-value pairs that will eventually be
associated with the S3 Object
Checks if Metadata property is set.
true if Metadata property is set.
Removes a key from the Metadata list if it was
added previously
The key to remove
Sets the StorageClass property for this request.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
for
information on S3 Storage Classes.
The Storage Class to be set on the object
The request with the StorageClass set
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the CannedACL property.
If set, the S3 Object will have this CannedACL
permission. Please refer to
for
information on S3 Canned ACLs.
Gets and sets the ContentType property.
Gets and sets the StorageClass property.
Default: S3StorageClass.Standard. Set this property
only if you want reduced redundancy for this object.
Please refer to
for
information on S3 Storage Classes.
The GetBucketVersioningResponse contains the GetBucketVersioningResult and
any headers returned by S3.
Gets and sets the Versioning property.
Unless Versioning has been explicitly "Enabled" on a bucket,
Versioning Status is "Off". Once Versioning has been
"Enabled", it can be "Suspended" but cannot be switched "Off".
The AbortMultipartUploadRequest contains the parameters used for the AbortMultipartUpload method.
Required Parameters: BucketName, Key, UploadId
Sets the BucketName property for this request.
The value that BucketName is set to
the request with the BucketName set
Checks if BucketName property is set.
true if BucketName property is set.
Sets the Key property for this request.
This is the Key for the S3 Object.
The value that Key is set to
the request with the Key set
Checks if Key property is set.
true if Key property is set.
Sets the UploadId property for this request.
This is the upload id for the multipart upload in process.
The value that UploadId is set to
the request with the UploadId set
Checks if UploadId property is set.
true if UploadId property is set.
Gets and sets the BucketName property.
Gets and sets the Key property.
Gets and sets the UploadId property.
This is the upload id for the multipart upload in process.
Response Unmarshaller for DescribeEvents operation
DescribeDBSecurityGroupsResult Unmarshaller
Describe D B Parameters Request Marshaller
Response Unmarshaller for DeleteDBInstance operation
DBInstance Unmarshaller
Response Unmarshaller for CreateDBSnapshot operation
Result Unmarshaller for CreateDBSecurityGroup operation
AvailabilityZone Unmarshaller
The results from the RebootDBInstance action.
Gets and sets the RebootDBInstanceResult property.
Contains the result of a successful invocation of the RebootDBInstance
action.
Returns information about the ModifyDBInstance response and response metadata.
Gets and sets the ModifyDBInstanceResult property.
Contains the result of a successful invocation of the ModifyDBInstance
action.
Returns information about the DescribeDBSnapshotsResult response and response metadata.
Gets and sets the DescribeDBSnapshotsResult property.
Contains the result of a successful invocation of the DescribeDBSnapshots action.
Container for the parameters to the DeleteDBSecurityGroup operation.
Deletes a database security group. NOTE:The specified database security group must not be associated with any DB
instances.
Sets the DBSecurityGroupName property
The value to set for the DBSecurityGroupName property
this instance
The name of the database security group to delete. You cannot delete the default security group. Constraints: - Must be
1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive
hyphens
Container for the parameters to the CreateDBParameterGroup operation.
Creates a new database parameter group.
Sets the DBParameterGroupName property
The value to set for the DBParameterGroupName property
this instance
Sets the DBParameterGroupFamily property
The value to set for the DBParameterGroupFamily property
this instance
Sets the Description property
The value to set for the Description property
this instance
The name of the DB Parameter Group. Constraints: - Must be 1 to 255 alphanumeric characters
- First character must be a
letter
- Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lower-case
string.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be
applied only to a DB instance running a database engine compatible with that DB parameter group family and version.
The description for the DB Parameter Group.
Configuration for accessing Amazon Relational Database Service service
Default constructor
Gets the ServiceVersion property.
Response Unmarshaller for GetStatus operation
AmazonImportExport exception
Constructs a new InvalidParameterException with the specified error
message.
Describes the error encountered.
AmazonImportExport exception
Constructs a new InvalidFileSystemException with the specified error
message.
Describes the error encountered.
Output structure for the CreateJob operation.
Sets the JobId property
The value to set for the JobId property
this instance
Sets the JobType property
The value to set for the JobType property
this instance
Sets the AwsShippingAddress property
The value to set for the AwsShippingAddress property
this instance
Sets the Signature property
The value to set for the Signature property
this instance
Sets the SignatureFileContents property
The value to set for the SignatureFileContents property
this instance
Sets the WarningMessage property
The value to set for the WarningMessage property
this instance
A unique identifier which refers to a particular job.
Specifies whether the job to initiate is an import or export job.
Constraints:
-
Allowed Values
Import, Export
Address you ship your storage device to.
An encrypted code used to authenticate the request and response, for
example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you
want to create the signature file yourself. Generally you should use
the SignatureFileContents value.
The actual text of the SIGNATURE file to be written to disk.
An optional message notifying you of non-fatal issues with the job,
such as use of an incompatible Amazon S3 bucket name.
Container for the parameters to the CreateJob operation.
This operation initiates the process of scheduling an upload or
download of your data. You include in the request a manifest that
describes the data transfer specifics. The response to the request
includes a job ID, which you can use in other operations, a signature
that you use to identify your storage device, and the address where
you should ship your storage device.
Sets the JobType property
The value to set for the JobType property
this instance
Sets the Manifest property
The value to set for the Manifest property
this instance
Sets the ManifestAddendum property
The value to set for the ManifestAddendum property
this instance
Sets the ValidateOnly property
The value to set for the ValidateOnly property
this instance
Specifies whether the job to initiate is an import or export job.
Constraints:
-
Allowed Values
Import, Export
The UTF-8 encoded text of the manifest file.
For internal use only.
Validate the manifest and parameter values in the request but do not
actually create a job.
Contains the result of a successful invocation of the
UploadServerCertificate action.
Sets the ServerCertificateMetadata property
The value to set for the ServerCertificateMetadata property
this instance
The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
Response Unmarshaller for UpdateUser operation
Response Unmarshaller for PutUserPolicy operation
ListServerCertificatesResult Unmarshaller
ListMFADevicesResult Unmarshaller
Response Unmarshaller for ListAccountAliases operation
Response Unmarshaller for GetUser operation
GetLoginProfileResult Unmarshaller
Response Unmarshaller for DeleteUser operation
Response Unmarshaller for DeleteAccountAlias operation
Response Unmarshaller for CreateUser operation
Container for the parameters to the ListUserPolicies operation.
Lists the names of the policies associated with the specified
User. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and
Marker parameters.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
Sets the MaxItems property
The value to set for the MaxItems property
this instance
The name of the User to list policies for.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Set it to the value of the Marker element in the response you just received.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional
policy names beyond the maximum you specify, the IsTruncated response element is true.
Constraints:
-
Range
1 - 1000
Contains the result of a successful invocation of the ListGroups
action.
Adds elements to the Groups collection
The values to add to the Groups collection
this instance
Adds elements to the Groups collection
The values to add to the Groups collection
this instance
Sets the IsTruncated property
The value to set for the IsTruncated property
this instance
Sets the Marker property
The value to set for the Marker property
this instance
A list of groups.
A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more groups in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent
pagination request.
Constraints:
-
Length
1 - 320
-
Pattern
[\u0020-\u00FF]*
Returns information about the GetAccountSummaryResult response and response metadata.
Gets and sets the GetAccountSummaryResult property.
Contains the result of a successful invocation of the GetAccountSummary action.
Container for the parameters to the GetAccountSummary operation.
Retrieves account level information about account entity usage
and IAM quotas. For information about limitations on IAM
entities, see Limitations on IAM Entities in Using AWS Identity and
Access Management .
Container for the parameters to the EnableMFADevice operation.
Enables the specified MFA device and associates it with the
specified User name. When enabled, the MFA device is required for
every subsequent login by the User name associated with the
device.
Sets the UserName property
The value to set for the UserName property
this instance
Sets the SerialNumber property
The value to set for the SerialNumber property
this instance
Sets the AuthenticationCode1 property
The value to set for the AuthenticationCode1 property
this instance
Sets the AuthenticationCode2 property
The value to set for the AuthenticationCode2 property
this instance
Name of the User for whom you want to enable the MFA device.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
The serial number that uniquely identifies the MFA device.
Constraints:
-
Length
9 - 48
-
Pattern
[\w]*
An authentication code emitted by the device.
Constraints:
-
Length
6 - 6
-
Pattern
[\d]*
A subsequent authentication code emitted by the device.
Constraints:
-
Length
6 - 6
-
Pattern
[\d]*
Container for the parameters to the AddUserToGroup operation.
Adds the specified User to the specified group.
Sets the GroupName property
The value to set for the GroupName property
this instance
Sets the UserName property
The value to set for the UserName property
this instance
Name of the group to update.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
Name of the User to add.
Constraints:
-
Length
1 - 128
-
Pattern
[\w+=,.@-]*
StepExecutionStatusDetail Unmarshaller
Describe Job Flows Request Marshaller
Specifies the execution state of a step.
Sets the State property
The value to set for the State property
this instance
Sets the CreationDateTime property
The value to set for the CreationDateTime property
this instance
Sets the StartDateTime property
The value to set for the StartDateTime property
this instance
Sets the EndDateTime property
The value to set for the EndDateTime property
this instance
Sets the LastStateChangeReason property
The value to set for the LastStateChangeReason property
this instance
The state of the job flow step.
Constraints:
-
Allowed Values
PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED
The creation date and time of the step.
The start date and time of the step.
The completion date and time of the step.
A description of the step's current state.
Constraints:
-
Length
0 - 10280
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The action to take if your step is waiting for the instance group to start
and it enters the Arrested state.
Fail - Fail the step.
Wait - Continue waiting until the instance group is no longer arrested (requires
manual intervention).
Continue - Proceed onto the next step.
Action to take if there is a failure modifying your cluster composition.
Fail - Fail the step.
Continue - Proceed on to the next step.
This class provides some helper methods for creating a Resize Job Flow step
as part of your job flow. The resize step can be used to automatically
adjust the composition of your cluster while it is running. For example, if
you have a large workflow with different compute requirements, you can use
this step to automatically add a task instance group before your most compute
intensive step.
AWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);
AmazonElasticMapReduce emr = new AmazonElasticMapReduceClient(credentials);
HadoopJarStepConfig config = new ResizeJobFlowStep()
.WithResizeAction(new ModifyInstanceGroup()
.WithInstanceGroup("core")
.WithInstanceCount(10))
.WithResizeAction(new AddInstanceGroup()
.WithInstanceGroup("task")
.WithInstanceCount(10)
.WithInstanceType("m1.small"))
.WithOnArrested(OnArrested.Continue)
.WithOnFailure(OnFailure.Continue)
.ToHadoopJarStepConfig();
StepConfig resizeJobFlow = new StepConfig()
.WithName("Resize job flow")
.WithActionOnFailure("TERMINATE_JOB_FLOW")
.WithHadoopJarStep(config);
RunJobFlowRequest request = new RunJobFlowRequest()
.WithName("Resize job flow")
.WithSteps(resizeJobFlow)
.WithLogUri("s3://log-bucket/")
.WithInstances(new JobFlowInstancesConfig()
.WithEc2KeyName("keypair")
.WithHadoopVersion("0.20")
.WithInstanceCount(5)
.WithKeepJobFlowAliveWhenNoSteps(true)
.WithMasterInstanceType("m1.small")
.WithSlaveInstanceType("m1.small"));
RunJobFlowResult result = emr.RunJobFlow(request).RunJobFlowResult;
Creates a new ResizeJobFlowStep using the default Elastic Map Reduce
bucket (us-east-1.elasticmapreduce) for the default (us-east-1) region.
Creates a new ResizeJobFlowStep using the specified Amazon S3 bucket to
load resources.
The official bucket format is "<region>.elasticmapreduce", so if
you're using the us-east-1 region, you should use the bucket
"us-east-1.elasticmapreduce".
The Amazon S3 bucket from which to load resources.
Add a new action for this step to perform. These actions can be to modify
or add instance groups. This step supports multiple actions, but requires
at least one be specified.
An instance of ResizeAction defining the change.
A reference to this updated object so that method calls can be chained
together.
Specifies whether the step should wait for the modification to complete
or if it should just continue onto the next step once the modification
request is received. Defaults to true.
Whether this step should wait for the modification to complete.
A reference to this updated object so that method calls can be chained
together.
What action this step should take if any of the instance group modifications result
in the instance group entering Arrested state. This can happen when the bootstrap
actions on the newly launched instances are continuously failing.
OnArrested enum specifying which action to take
A reference to this updated object so that method calls can be chained
together.
What action this step should take if the modification fails. This can happen when
you request to perform an invalid action, such as shrink a core instance group.
OnFailure enum specifying which action to take.
A reference to this updated object so that method calls can be chained
together.
Creates the final HadoopJarStepConfig once you are done configuring the step. You can use
this as you would any other HadoopJarStepConfig.
HadoopJarStepConfig configured to perform the specified actions.
Class representing a change to an existing instance group.
Set the identification for the instance group to modify. You can specify either
core or task if there is only one instance group of that role. Otherwise you can
specify the instance group ID (such as ig-ABABABABABAB).
Identifier for the instance group.
A reference to this updated object so that method calls can be chained
together.
Specify the new size of the instance group.
Target size of the instance group.
A reference to this updated object so that method calls can be chained
together.
Class representing creating a new instance group.
Specify the role of the new instance group (core, task).
New instance group's role.
A reference to this updated object so that method calls can be chained
together.
Specify the count of the new instance group.
Target instance group size.
A reference to this updated object so that method calls can be chained
together.
Specify the instance type to use for this instance group.
Instance type.
A reference to this updated object so that method calls can be chained
together.
Register Instances With Load Balancer Request Marshaller
Create Load Balancer Request Marshaller
The output for the DescribeInstanceHealth action.
Adds elements to the InstanceStates collection
The values to add to the InstanceStates collection
this instance
Adds elements to the InstanceStates collection
The values to add to the InstanceStates collection
this instance
A list containing health information for the specified instances.
AmazonElasticLoadBalancing exception
Constructs a new CertificateNotFoundException with the specified error
message.
Describes the error encountered.
Returns information about the UpdateApplicationVersionResult response and response metadata.
Gets and sets the UpdateApplicationVersionResult property.
Result message wrapping a single description of an application version.
Response Unmarshaller for ValidateConfigurationSettings operation
Response Unmarshaller for RebuildEnvironment operation
Response Unmarshaller for ListAvailableSolutionStacks operation
Response Unmarshaller for DescribeEnvironments operation
DescribeEnvironmentResourcesResult Unmarshaller
Describe Application Versions Request Marshaller
Container for the parameters to the DescribeApplicationVersions operation.
Returns descriptions for existing application versions.
Sets the ApplicationName property
The value to set for the ApplicationName property
this instance
Adds elements to the VersionLabels collection
The values to add to the VersionLabels collection
this instance
Adds elements to the VersionLabels collection
The values to add to the VersionLabels collection
this instance
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified
application.
Constraints:
-
Length
1 - 100
If specified, restricts the returned descriptions to only include ones that have the specified version labels.
Result message containing a list of application descriptions.
Adds elements to the Applications collection
The values to add to the Applications collection
this instance
Adds elements to the Applications collection
The values to add to the Applications collection
this instance
This parameter contains a list of ApplicationDescription.
Disables monitoring for a running instance. For
more information, refer to the
Amazon CloudWatch Developer Guide.
Sets the InstanceId property
Instance ID.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Gets and sets the InstanceId property.
Instance ID.
Describes the components of a Spot Instance request.
Sets the SpotInstanceRequestId property
The ID of the SpotInstanceRequest.
this instance
Checks if SpotInstanceRequestId property is set
true if SpotInstanceRequestId property is set
Sets the SpotPrice property
Specifies the maximum price you will pay to
launch one or more Spot Instances.
this instance
Checks if SpotPrice property is set
true if SpotPrice property is set
Sets the Type property
The instance type (eg. m1.small)
this instance
Checks if Type property is set
true if Type property is set
Sets the State property
The state of the Spot Instance request.
Possible values:
open|closed|cancelled|failed
this instance
Checks if State property is set
true if State property is set
Sets the Fault property
Fault details for the Spot Instance request, if any.
this instance
Checks if Fault property is set
true if Fault property is set
Sets the ValidFrom property
Start date of the request. If this is a
one-time request, the request
remains active until all instances
launch, the request expires, or
the request is canceled. If the
request is persistent, it remains
active until it expires or is
canceled.
this instance
Checks if ValidFrom property is set
true if ValidFrom property is set
Sets the ValidUntil property
End date of the request. If this is a one-time
request, the request
remains active until all instances launch,
the request expires, or
the request is canceled. If the request is
persistent, it remains
active until it expires or is canceled.
this instance
Checks if ValidUntil property is set
true if ValidUntil property is set
Sets the LaunchGroup property
Specifies the instance launch group. Launch
groups are Spot
Instances that launch together and terminate
together.
this instance
Checks if LaunchGroup property is set
true if LaunchGroup property is set
Sets the AvailabilityZoneGroup property
Specifies the Availability Zone group. If you
specify the same Availability Zone group for
all Spot Instance requests, all Spot
Instances are launched in the same
Availability Zone.
this instance
Checks if AvailabilityZoneGroup property is set
true if AvailabilityZoneGroup property is set
Sets the LaunchSpecification property
Specifies additional launch instance
information.
this instance
Checks if LaunchSpecification property is set
true if LaunchSpecification property is set
Sets the InstanceId property
The instance associated with the Spot Instance
Request.
this instance
Checks if InstanceId property is set
true if InstanceId property is set
Sets the CreateTime property
Time stamp when the Spot Instance request was
fulfilled.
this instance
Checks if CreateTime property is set
true if CreateTime property is set
Sets the ProductDescription property
The product description associated with the
Spot Instance.
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Sets the Tag property
A list of tags for the specified resources.
this instance
Checks if Tag property is set
true if Tag property is set
Sets the LaunchedAvailabilityZone property
The Availability Zone in which the bid is launched.
this instance
Checks if LaunchedAvailabilityZone property is set
true if LaunchedAvailabilityZone property is set
Gets and sets the SpotInstanceRequestId property.
The ID of the SpotInstanceRequest.
Gets and sets the SpotPrice property.
Specifies the maximum price you will pay to
launch one or more Spot Instances.
Gets and sets the Type property.
The instance type (eg. m1.small)
Gets and sets the State property.
The state of the Spot Instance request.
Possible values:
open|closed|cancelled|failed
Gets and sets the Fault property.
Fault details for the Spot Instance request, if any.
Gets and sets the ValidFrom property.
Start date of the request. If this is a
one-time request, the request
remains active until all instances
launch, the request expires, or
the request is canceled. If the
request is persistent, it remains
active until it expires or is
canceled.
Gets and sets the ValidUntil property.
End date of the request. If this is a one-time
request, the request
remains active until all instances launch,
the request expires, or
the request is canceled. If the request is
persistent, it remains
active until it expires or is canceled.
Gets and sets the LaunchGroup property.
Specifies the instance launch group. Launch
groups are Spot
Instances that launch together and terminate
together.
Gets and sets the AvailabilityZoneGroup property.
Specifies the Availability Zone group. If you
specify the same Availability Zone group for
all Spot Instance requests, all Spot
Instances are launched in the same
Availability Zone.
Gets and sets the LaunchSpecification property.
Specifies additional launch instance
information.
Gets and sets the InstanceId property.
The instance associated with the Spot Instance
Request.
Gets and sets the CreateTime property.
Time stamp when the Spot Instance request was
fulfilled.
Gets and sets the ProductDescription property.
The product description associated with the
Spot Instance.
Gets and sets the Tag property.
A list of tags for the specified resources.
Gets and sets the LaunchedAvailabilityZone property.
The Availability Zone in which the bid is launched.
Describes the Spot Datafeed subscription.
Sets the OwnerId property
The AWS account ID associated with the
subscription.
this instance
Checks if OwnerId property is set
true if OwnerId property is set
Sets the Bucket property
The Amazon S3 bucket where the Spot Instance
datafeed is located.
this instance
Checks if Bucket property is set
true if Bucket property is set
Sets the Prefix property
The Prefix prepended to the datafeed files.
this instance
Checks if Prefix property is set
true if Prefix property is set
Sets the State property
The state of the Spot Instance request.
this instance
Checks if State property is set
true if State property is set
Sets the Fault property
Fault details for the Spot Instance request, if
any.
this instance
Checks if Fault property is set
true if Fault property is set
Gets and sets the OwnerId property.
The AWS account ID associated with the
subscription.
Gets and sets the Bucket property.
The Amazon S3 bucket where the Spot Instance
datafeed is located.
Gets and sets the Prefix property.
The Prefix prepended to the datafeed files.
Gets and sets the State property.
The state of the Spot Instance request.
Gets and sets the Fault property.
Fault details for the Spot Instance request, if
any.
Reserved Instances
Sets the ReservedInstancesId property
The ID of the Reserved Instances.
this instance
Checks if ReservedInstancesId property is set
true if ReservedInstancesId property is set
Sets the InstanceType property
The instance type on which the Reserved
Instance can be used.
this instance
Checks if InstanceType property is set
true if InstanceType property is set
Sets the AvailabilityZone property
The Availability Zone in which the Reserved
Instance can be used.
this instance
Checks if AvailabilityZone property is set
true if AvailabilityZone property is set
Sets the Duration property
The duration of the Reserved Instance, in
seconds.
this instance
Checks if Duration property is set
true if Duration property is set
Sets the UsagePrice property
The usage price of the Reserved Instance, per
hour.
this instance
Checks if UsagePrice property is set
true if UsagePrice property is set
Sets the FixedPrice property
The purchase price of the Reserved Instance.
this instance
Checks if FixedPrice property is set
true if FixedPrice property is set
Sets the InstanceCount property
The number of Reserved Instances purchased.
this instance
Checks if InstanceCount property is set
true if InstanceCount property is set
Sets the ProductDescription property
The Reserved Instance description.
this instance
Checks if ProductDescription property is set
true if ProductDescription property is set
Sets the PurchaseState property
The state of the Reserved Instance purchase.
Valid Values:
pending-payment | active | payment-failed | retired
this instance
Checks if PurchaseState property is set
true if PurchaseState property is set
Sets the StartTime property
The date and time the Reserved Instance
started.
this instance
Checks if StartTime property is set
true if StartTime property is set
Sets the Tag property
A list of tags for the ReservedInstances.
this instance
Checks if Tag property is set
true if Tag property is set
Checks if InstanceTenancy property is set
true if InstanceTenancy property is set
Sets the InstanceTenancy property
The tenancy of the reserved instance.
this instance
Checks if CurrencyCode property is set
true if InstanceTenancy property is set
Sets the CurrencyCode property
The ISO 4217 CurrencyCode (e.g., USD, JPY).
this instance
Gets and sets the ReservedInstancesId property.
The ID of the Reserved Instances.
Gets and sets the InstanceType property.
The instance type on which the Reserved
Instance can be used.
Gets and sets the AvailabilityZone property.
The Availability Zone in which the Reserved
Instance can be used.
Gets and sets the Duration property.
The duration of the Reserved Instance, in
seconds.
Gets and sets the UsagePrice property.
The usage price of the Reserved Instance, per
hour.
Gets and sets the FixedPrice property.
The purchase price of the Reserved Instance.
Gets and sets the InstanceCount property.
The number of Reserved Instances purchased.
Gets and sets the ProductDescription property.
The Reserved Instance description.
Gets and sets the PurchaseState property.
The state of the Reserved Instance purchase.
Valid Values:
pending-payment | active | payment-failed | retired
Gets and sets the StartTime property.
The date and time the Reserved Instance
started.
Gets and sets the Tag property.
A list of tags for the ReservedInstances.
Gets and sets the InstanceTenancy property.
The tenancy of the reserved instance.
Gets and sets the CurrencyCode property.
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard (e.g., USD, JPY).
ReplaceNetworkAclAssociation Result
Checks if NewAssociationId property is set
true if NewAssociationId property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the NewAssociationId property.
The ID representing the new association.
Instance State
Sets the Code property
A 16-bit unsigned integer. The high byte is an
opaque internal value and should be
ignored. The low byte is set
based on the state represented.
Valid values are: 0 (pending) |
16 (running) | 32 (shutting-down) |
48 (terminated) | 64
(stopping) | 80 (stopped)
this instance
Checks if Code property is set
true if Code property is set
Sets the Name property
The current state of the instance.
Valid values are: pending | running | shutting-down | terminated |
stopping | stopped
this instance
Checks if Name property is set
true if Name property is set
Gets and sets the Code property.
A 16-bit unsigned integer. The high byte is an
opaque internal value and should be
ignored. The low byte is set
based on the state represented.
Valid values are: 0 (pending) |
16 (running) | 32 (shutting-down) |
48 (terminated) | 64
(stopping) | 80 (stopped)
Gets and sets the Name property.
The current state of the instance.
Valid values are: pending | running | shutting-down | terminated |
stopping | stopped
Sets the Code property
The ICMP code. A value of -1 is a wildcard meaning all codes.
this instance
Checks if Code property is set
true if Code property is set
Sets the Type property
The ICMP type. A value of -1 is a wildcard meaning all types.
this instance
Checks if Type property is set
true if Type property is set
Gets and sets the Code property.
The ICMP code. A value of -1 is a wildcard meaning all codes.
Gets and sets the Type property.
The ICMP type. A value of -1 is a wildcard meaning all types.
Detaches a VPN 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 VPN gateway has been
completely detached from a VPC by
describing the VPN gateway (any
attachments to the VPN gateway are
also described).
You must wait for the attachment's state to switch
to detached before you
can delete the VPC or attach a different VPC
to the VPN gateway.
Sets the VpnGatewayId property
The ID of the VPN gateway you want to detach
from the VPC
this instance
Checks if VpnGatewayId property is set
true if VpnGatewayId property is set
Sets the VpcId property
The ID of the VPC you want to detach the VPN
gateway from.
this instance
Checks if VpcId property is set
true if VpcId property is set
Gets and sets the VpnGatewayId property.
The ID of the VPN gateway you want to detach
from the VPC
Gets and sets the VpcId property.
The ID of the VPC you want to detach the VPN
gateway from.
Describe Volumes Response
Checks if DescribeVolumesResult property is set
true if DescribeVolumesResult property is set
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the DescribeVolumesResult property.
Describe Volumes Result
Gets and sets the ResponseMetadata property.
Response Metadata
Describe Snapshot Attribute Result
Checks if SnapshotAttribute property is set
true if SnapshotAttribute property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the SnapshotAttribute property.
list of snapshot attributes
Describe Reserved Instances Offerings Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeReservedInstancesOfferingsResult property is set
true if DescribeReservedInstancesOfferingsResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeReservedInstancesOfferingsResult property.
Describe Reserved Instances Offerings Result
Describe Image Attribute Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if DescribeImageAttributeResult property is set
true if DescribeImageAttributeResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the DescribeImageAttributeResult property.
Describe Image Attribute Result
Delete Vpn Connection Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For
more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.
Sets the InternetGatewayId property
The ID of the Internet gateway to be deleted.
this instance
Checks if InternetGatewayId property is set
true if InternetGatewayId property is set
Gets and sets the InternetGatewayId property.
The ID of the Internet gateway to be deleted.
Delete Customer Gateway Response
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Create Snapshot Result
Checks if Snapshot property is set
true if Snapshot property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the Snapshot property.
Snapshot
Information returned by a CreateImage request.
Checks if ResponseMetadata property is set
true if ResponseMetadata property is set
Checks if CreateImageResult property is set
true if CreateImageResult property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the ResponseMetadata property.
Response Metadata
Gets and sets the CreateImageResult property.
Information about the created image.
Cancel Bundle Task Result
Checks if BundleTask property is set
true if BundleTask property is set
XML Representation of this object
XML String
String Representation of this object. Overrides Object.ToString()
This object as a string
Gets and sets the BundleTask property.
List of bundle tasks
Block device mapping.
Sets the DeviceName property
The device name (e.g., /dev/sdh).
this instance
Checks if DeviceName property is set
true if DeviceName property is set
Sets the VirtualName property
The virtual name.
this instance
Checks if VirtualName property is set
true if VirtualName property is set
Sets the Ebs property
Specifies parameters used to automatically
setup Amazon EBS
volumes when the instance is launched.
this instance
Checks if Ebs property is set
true if Ebs property is set
Sets the NoDevice property
Specifies the device name to suppress during
instance launch.
this instance
Checks if NoDevice property is set
true if NoDevice property is set
Gets and sets the DeviceName property.
The device name (e.g., /dev/sdh).
Gets and sets the VirtualName property.
The virtual name.
Gets and sets the Ebs property.
Specifies parameters used to automatically
setup Amazon EBS
volumes when the instance is launched.
Gets and sets the NoDevice property.
Specifies the device name to suppress during
instance launch.
Response Unmarshaller for PutMetricData operation
Response Unmarshaller for DisableAlarmActions operation
AmazonCloudWatch exception
Constructs a new LimitExceededException with the specified error
message.
Describes the error encountered.
The Datapoint data type encapsulates the statistical
data that Amazon CloudWatch computes from metric data.
Sets the Timestamp property
The value to set for the Timestamp property
this instance
Sets the SampleCount property
The value to set for the SampleCount property
this instance
Sets the Average property
The value to set for the Average property
this instance
Sets the Sum property
The value to set for the Sum property
this instance
Sets the Minimum property
The value to set for the Minimum property
this instance
Sets the Maximum property
The value to set for the Maximum property
this instance
Sets the Unit property
The value to set for the Unit property
this instance
The time stamp used for the datapoint.
The number of metric values that contributed to the aggregate value of this datapoint.
The average of metric values that correspond to the datapoint.
The sum of metric values used for the datapoint.
The minimum metric value used for the datapoint.
The maximum of the metric value used for the datapoint.
The standard unit used for the datapoint.
Constraints:
-
Allowed Values
Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
The GetDistributionConfigResponse contains the distribution's configuration
and any headers returned by CloudFront.
Gets and Sets the DistributionConfig property.
Gets and sets the ETag property.
The Distribution Configuration's ETag property is also set if possible.
Describes a streaming distribution's configuration.
It is used as a request element in Create a Distribution and Set a Distribution's Configuration.
It is used as a response element in Get a Distribution's Information and Get a Distribution's
Configuration.
A streaming distribution configuration objects consists of the following items:
- Caller Reference
- Origin S3 Bucket
- Comment
- A list of CNAMEs for the distribution
- Enabled flag
- Bucket Logging details
- CloudFront Origin Access Identity associated with the distribution.
This is a virtual identity you use to let CloudFront fetch private content
from your bucket.
- The AWS Accounts that have URL signing privileges for Private Content.
For more information, please visit:
Creates an XML representation of the CloudFront
distribution configuration. The resulting XML
can be sent to CloudFront when creating or updating
a distribution.
XML representation of the distribution's configuration
Sets the Origin property.
Origin property
this instance
Sets the Comment property.
Comment property
this instance
Sets the CallerReference property
CallerReference property
this instance
Sets the CNAME property. If you set more than 10 CNAME aliases for a distribution,
a TooManyDistributionCNAMEs exception will be returned by CloudFront.
CNAME property
this instance
Sets the Enabled property
Enabled property
this instance
Sets the OriginAccessIdentity property.
OriginAccessIdentity property
this instance
Sets the TrustedSigners property.
This specifies any AWS accounts you want to permit to create signed URLs for private content.
TrustedSigners property is set to this value
this instance
Sets the Logging property.
The bucket into which logs will be put
The prefix for the log files
this instance
Describes a CloudFront Distribution.
It is used as a response element when Creating a Distribution and Getting a Distribution's Information.
A distribution consists of the following items:
- Id
- Status
- Last Modified Timestamp
- Domain Name
- The Configuration for the Distribution
For more information, please visit:
Checks if DistributionConfig property is set
true if DistributionConfig property is set
Gets and sets the current Distribution Configuration.
Output Unmarshaller
Response Unmarshaller for ListStackResources operation
Response Unmarshaller for DescribeStackResources operation
Container for the parameters to the UpdateAutoScalingGroup operation.
Updates the configuration for the specified AutoScalingGroup. NOTE: To update an Auto Scaling group with a
launch configuration that has the InstanceMonitoring.enabled flag set to false, you must first ensure that collection of group metrics is
disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable
collection of all group metrics by calling DisableMetricsCollection. The new settings are registered upon the completion of
this call. Any launch configuration settings take effect on any triggers after this call returns. Triggers that are currently in progress
aren't affected. NOTE: If the new values are specified for the MinSize or MaxSize parameters, then there will be an
implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the
request.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the LaunchConfigurationName property
The value to set for the LaunchConfigurationName property
this instance
Sets the MinSize property
The value to set for the MinSize property
this instance
Sets the MaxSize property
The value to set for the MaxSize property
this instance
Sets the DesiredCapacity property
The value to set for the DesiredCapacity property
this instance
Sets the DefaultCooldown property
The value to set for the DefaultCooldown property
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Adds elements to the AvailabilityZones collection
The values to add to the AvailabilityZones collection
this instance
Sets the HealthCheckType property
The value to set for the HealthCheckType property
this instance
Sets the HealthCheckGracePeriod property
The value to set for the HealthCheckGracePeriod property
this instance
Sets the PlacementGroup property
The value to set for the PlacementGroup property
this instance
Sets the VPCZoneIdentifier property
The value to set for the VPCZoneIdentifier property
this instance
The name of the Auto Scaling group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name of the launch configuration.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The minimum size of the Auto Scaling group.
The maximum size of the Auto Scaling group.
The desired capacity for the Auto Scaling group.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
Availability zones for the group.
Constraints:
-
Length
1 -
The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
Constraints:
-
Length
1 - 32
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into
service.
The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2
User Guide.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The identifier for the VPC connection, if applicable.
Constraints:
-
Length
1 - 255
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update Auto Scaling Group Request Marshaller
Put Scheduled Update Group Action Request Marshaller
Instance Unmarshaller
DescribeLaunchConfigurationsResult Unmarshaller
Describe Auto Scaling Notification Types Request Marshaller
Create Launch Configuration Request Marshaller
Returns information about the PutScalingPolicyResult response and response metadata.
Gets and sets the PutScalingPolicyResult property.
The PolicyARNType data type.
Container for the parameters to the PutNotificationConfiguration operation.
Creates a notification action for an Auto Scaling group when a specified event takes place.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the TopicARN property
The value to set for the TopicARN property
this instance
Adds elements to the NotificationTypes collection
The values to add to the NotificationTypes collection
this instance
Adds elements to the NotificationTypes collection
The values to add to the NotificationTypes collection
this instance
The name of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The type of events for this action to start.
Container for the parameters to the ExecutePolicy operation.
Runs the policy you create for your Auto Scaling group in PutScalingPolicy.
Sets the AutoScalingGroupName property
The value to set for the AutoScalingGroupName property
this instance
Sets the PolicyName property
The value to set for the PolicyName property
this instance
Sets the HonorCooldown property
The value to set for the HonorCooldown property
this instance
The name or ARN of the Auto Scaling Group.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
The name or PolicyARN of the policy you want to run.
Constraints:
-
Length
1 - 1600
-
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Set to True if you want Auto Scaling to reject this request if the Auto Scaling group is in cooldown.