com.amazonaws.services.cloudcontrolapi

Class AbstractAWSCloudControlApi

java.lang.Object

com.amazonaws.services.cloudcontrolapi.AbstractAWSCloudControlApi

All Implemented Interfaces:

AWSCloudControlApi

Direct Known Subclasses:

AbstractAWSCloudControlApiAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCloudControlApi
extends Object
implements AWSCloudControlApi

Abstract implementation of AWSCloudControlApi. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.cloudcontrolapi.AWSCloudControlApi

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CancelResourceRequestResult	cancelResourceRequest(CancelResourceRequestRequest request) Cancels the specified resource operation request.
CreateResourceResult	createResource(CreateResourceRequest request) Creates the specified resource.
DeleteResourceResult	deleteResource(DeleteResourceRequest request) Deletes the specified resource.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetResourceResult	getResource(GetResourceRequest request) Returns information about the current state of the specified resource.
GetResourceRequestStatusResult	getResourceRequestStatus(GetResourceRequestStatusRequest request) Returns the current status of a resource operation request.
ListResourceRequestsResult	listResourceRequests(ListResourceRequestsRequest request) Returns existing resource operation requests.
ListResourcesResult	listResources(ListResourcesRequest request) Returns information about the specified resources.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateResourceResult	updateResource(UpdateResourceRequest request) Updates the specified property values in the resource.
AWSCloudControlApiWaiters	waiters()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cancelResourceRequest

public CancelResourceRequestResult cancelResourceRequest(CancelResourceRequestRequest request)

Description copied from interface: AWSCloudControlApi

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be cancelled.

Specified by:

cancelResourceRequest in interface AWSCloudControlApi

Returns:

Result of the CancelResourceRequest operation returned by the service.

See Also:

AWS API Documentation

createResource

public CreateResourceResult createResource(CreateResourceRequest request)

Description copied from interface: AWSCloudControlApi

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource.

Specified by:

createResource in interface AWSCloudControlApi

Returns:

Result of the CreateResource operation returned by the service.

See Also:

AWS API Documentation

deleteResource

public DeleteResourceResult deleteResource(DeleteResourceRequest request)

Description copied from interface: AWSCloudControlApi

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

Specified by:

deleteResource in interface AWSCloudControlApi

Returns:

Result of the DeleteResource operation returned by the service.

See Also:

AWS API Documentation

getResource

public GetResourceResult getResource(GetResourceRequest request)

Description copied from interface: AWSCloudControlApi

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Specified by:

getResource in interface AWSCloudControlApi

Returns:

Result of the GetResource operation returned by the service.

See Also:

AWS API Documentation

getResourceRequestStatus

public GetResourceRequestStatusResult getResourceRequestStatus(GetResourceRequestStatusRequest request)

Description copied from interface: AWSCloudControlApi

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Specified by:

getResourceRequestStatus in interface AWSCloudControlApi

Returns:

Result of the GetResourceRequestStatus operation returned by the service.

See Also:

AWS API Documentation

listResourceRequests

public ListResourceRequestsResult listResourceRequests(ListResourceRequestsRequest request)

Description copied from interface: AWSCloudControlApi

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Resource operation requests expire after seven days.

Specified by:

listResourceRequests in interface AWSCloudControlApi

Returns:

Result of the ListResourceRequests operation returned by the service.

See Also:

AWS API Documentation

listResources

public ListResourcesResult listResources(ListResourcesRequest request)

Description copied from interface: AWSCloudControlApi

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Specified by:

listResources in interface AWSCloudControlApi

Returns:

Result of the ListResources operation returned by the service.

See Also:

AWS API Documentation

updateResource

public UpdateResourceResult updateResource(UpdateResourceRequest request)

Description copied from interface: AWSCloudControlApi

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.

For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the Amazon Web Services CloudFormation Users Guide.

Specified by:

updateResource in interface AWSCloudControlApi

Returns:

Result of the UpdateResource operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSCloudControlApi

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSCloudControlApi

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSCloudControlApi

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSCloudControlApi

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AWSCloudControlApiWaiters waiters()

Specified by:

waiters in interface AWSCloudControlApi