/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the cloudcontrol-2021-09-30.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.CloudControlApi.Model;
namespace Amazon.CloudControlApi
{
///
/// Interface for accessing CloudControlApi
///
/// For more information about Amazon Web Services Cloud Control API, see the Amazon
/// Web Services Cloud Control API User Guide.
///
public partial interface IAmazonCloudControlApi : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ICloudControlApiPaginatorFactory Paginators { get; }
#endif
#region CancelResourceRequest
///
/// 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 canceled.
///
///
/// Container for the necessary parameters to execute the CancelResourceRequest service method.
///
/// The response from the CancelResourceRequest service method, as returned by CloudControlApi.
///
/// The resource is currently being modified by another operation.
///
///
/// A resource operation with the specified request token can't be found.
///
/// REST API Reference for CancelResourceRequest Operation
CancelResourceRequestResponse CancelResourceRequest(CancelResourceRequestRequest request);
///
/// Initiates the asynchronous execution of the CancelResourceRequest operation.
///
///
/// Container for the necessary parameters to execute the CancelResourceRequest operation on AmazonCloudControlApiClient.
/// 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 EndCancelResourceRequest
/// operation.
/// REST API Reference for CancelResourceRequest Operation
IAsyncResult BeginCancelResourceRequest(CancelResourceRequestRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CancelResourceRequest operation.
///
///
/// The IAsyncResult returned by the call to BeginCancelResourceRequest.
///
/// Returns a CancelResourceRequestResult from CloudControlApi.
/// REST API Reference for CancelResourceRequest Operation
CancelResourceRequestResponse EndCancelResourceRequest(IAsyncResult asyncResult);
#endregion
#region CreateResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateResource service method.
///
/// The response from the CreateResource service method, as returned by CloudControlApi.
///
/// The resource with the name requested already exists.
///
///
/// The specified client token has already been used in another resource request.
///
///
///
/// It's best practice for client tokens to be unique for each resource operation request.
/// However, client token expire after 36 hours.
///
///
///
/// Another resource operation is currently being performed on this resource.
///
///
/// The resource handler has returned that the downstream service generated an error that
/// doesn't map to any other handler error code.
///
///
/// The resource handler has failed without a returning a more specific error code. This
/// can include timeouts.
///
///
/// The resource handler has returned that an unexpected error occurred within the resource
/// handler.
///
///
/// The resource handler has returned that the credentials provided by the user are invalid.
///
///
/// The resource handler has returned that invalid input from the user has generated a
/// generic exception.
///
///
/// The resource handler has returned that the request couldn't be completed due to networking
/// issues, such as a failure to receive a response from the server.
///
///
/// The resource handler has returned that the downstream resource failed to complete
/// all of its ready-state checks.
///
///
/// One or more properties included in this resource operation are defined as create-only,
/// and therefore can't be updated.
///
///
/// Cloud Control API hasn't received a valid response from the resource handler, due
/// to a configuration error. This includes issues such as the resource handler returning
/// an invalid response, or timing out.
///
///
/// The resource is temporarily unavailable to be acted upon. For example, if the resource
/// is currently undergoing an operation and can't be acted upon until that operation
/// is finished.
///
///
/// A resource with the specified identifier can't be found.
///
///
/// The resource handler has returned that the downstream service returned an internal
/// error, typically with a 5XX HTTP status code.
///
///
/// The resource handler has returned that a non-transient resource limit was reached
/// on the service side.
///
///
/// The request was denied due to request throttling.
///
///
/// The specified extension doesn't exist in the CloudFormation registry.
///
///
/// The specified resource doesn't support this resource operation.
///
/// REST API Reference for CreateResource Operation
CreateResourceResponse CreateResource(CreateResourceRequest request);
///
/// Initiates the asynchronous execution of the CreateResource operation.
///
///
/// Container for the necessary parameters to execute the CreateResource operation on AmazonCloudControlApiClient.
/// 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 EndCreateResource
/// operation.
/// REST API Reference for CreateResource Operation
IAsyncResult BeginCreateResource(CreateResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateResource operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateResource.
///
/// Returns a CreateResourceResult from CloudControlApi.
/// REST API Reference for CreateResource Operation
CreateResourceResponse EndCreateResource(IAsyncResult asyncResult);
#endregion
#region DeleteResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteResource service method.
///
/// The response from the DeleteResource service method, as returned by CloudControlApi.
///
/// The resource with the name requested already exists.
///
///
/// The specified client token has already been used in another resource request.
///
///
///
/// It's best practice for client tokens to be unique for each resource operation request.
/// However, client token expire after 36 hours.
///
///
///
/// Another resource operation is currently being performed on this resource.
///
///
/// The resource handler has returned that the downstream service generated an error that
/// doesn't map to any other handler error code.
///
///
/// The resource handler has failed without a returning a more specific error code. This
/// can include timeouts.
///
///
/// The resource handler has returned that an unexpected error occurred within the resource
/// handler.
///
///
/// The resource handler has returned that the credentials provided by the user are invalid.
///
///
/// The resource handler has returned that invalid input from the user has generated a
/// generic exception.
///
///
/// The resource handler has returned that the request couldn't be completed due to networking
/// issues, such as a failure to receive a response from the server.
///
///
/// The resource handler has returned that the downstream resource failed to complete
/// all of its ready-state checks.
///
///
/// One or more properties included in this resource operation are defined as create-only,
/// and therefore can't be updated.
///
///
/// Cloud Control API hasn't received a valid response from the resource handler, due
/// to a configuration error. This includes issues such as the resource handler returning
/// an invalid response, or timing out.
///
///
/// The resource is temporarily unavailable to be acted upon. For example, if the resource
/// is currently undergoing an operation and can't be acted upon until that operation
/// is finished.
///
///
/// A resource with the specified identifier can't be found.
///
///
/// The resource handler has returned that the downstream service returned an internal
/// error, typically with a 5XX HTTP status code.
///
///
/// The resource handler has returned that a non-transient resource limit was reached
/// on the service side.
///
///
/// The request was denied due to request throttling.
///
///
/// The specified extension doesn't exist in the CloudFormation registry.
///
///
/// The specified resource doesn't support this resource operation.
///
/// REST API Reference for DeleteResource Operation
DeleteResourceResponse DeleteResource(DeleteResourceRequest request);
///
/// Initiates the asynchronous execution of the DeleteResource operation.
///
///
/// Container for the necessary parameters to execute the DeleteResource operation on AmazonCloudControlApiClient.
/// 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 EndDeleteResource
/// operation.
/// REST API Reference for DeleteResource Operation
IAsyncResult BeginDeleteResource(DeleteResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteResource operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteResource.
///
/// Returns a DeleteResourceResult from CloudControlApi.
/// REST API Reference for DeleteResource Operation
DeleteResourceResponse EndDeleteResource(IAsyncResult asyncResult);
#endregion
#region GetResource
///
/// 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 those resources were provisioned using Cloud
/// Control API.
///
///
/// Container for the necessary parameters to execute the GetResource service method.
///
/// The response from the GetResource service method, as returned by CloudControlApi.
///
/// The resource with the name requested already exists.
///
///
/// The resource handler has returned that the downstream service generated an error that
/// doesn't map to any other handler error code.
///
///
/// The resource handler has failed without a returning a more specific error code. This
/// can include timeouts.
///
///
/// The resource handler has returned that an unexpected error occurred within the resource
/// handler.
///
///
/// The resource handler has returned that the credentials provided by the user are invalid.
///
///
/// The resource handler has returned that invalid input from the user has generated a
/// generic exception.
///
///
/// The resource handler has returned that the request couldn't be completed due to networking
/// issues, such as a failure to receive a response from the server.
///
///
/// The resource handler has returned that the downstream resource failed to complete
/// all of its ready-state checks.
///
///
/// One or more properties included in this resource operation are defined as create-only,
/// and therefore can't be updated.
///
///
/// Cloud Control API hasn't received a valid response from the resource handler, due
/// to a configuration error. This includes issues such as the resource handler returning
/// an invalid response, or timing out.
///
///
/// The resource is temporarily unavailable to be acted upon. For example, if the resource
/// is currently undergoing an operation and can't be acted upon until that operation
/// is finished.
///
///
/// A resource with the specified identifier can't be found.
///
///
/// The resource handler has returned that the downstream service returned an internal
/// error, typically with a 5XX HTTP status code.
///
///
/// The resource handler has returned that a non-transient resource limit was reached
/// on the service side.
///
///
/// The request was denied due to request throttling.
///
///
/// The specified extension doesn't exist in the CloudFormation registry.
///
///
/// The specified resource doesn't support this resource operation.
///
/// REST API Reference for GetResource Operation
GetResourceResponse GetResource(GetResourceRequest request);
///
/// Initiates the asynchronous execution of the GetResource operation.
///
///
/// Container for the necessary parameters to execute the GetResource operation on AmazonCloudControlApiClient.
/// 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 EndGetResource
/// operation.
/// REST API Reference for GetResource Operation
IAsyncResult BeginGetResource(GetResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetResource operation.
///
///
/// The IAsyncResult returned by the call to BeginGetResource.
///
/// Returns a GetResourceResult from CloudControlApi.
/// REST API Reference for GetResource Operation
GetResourceResponse EndGetResource(IAsyncResult asyncResult);
#endregion
#region GetResourceRequestStatus
///
/// 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.
///
/// Container for the necessary parameters to execute the GetResourceRequestStatus service method.
///
/// The response from the GetResourceRequestStatus service method, as returned by CloudControlApi.
///
/// A resource operation with the specified request token can't be found.
///
/// REST API Reference for GetResourceRequestStatus Operation
GetResourceRequestStatusResponse GetResourceRequestStatus(GetResourceRequestStatusRequest request);
///
/// Initiates the asynchronous execution of the GetResourceRequestStatus operation.
///
///
/// Container for the necessary parameters to execute the GetResourceRequestStatus operation on AmazonCloudControlApiClient.
/// 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 EndGetResourceRequestStatus
/// operation.
/// REST API Reference for GetResourceRequestStatus Operation
IAsyncResult BeginGetResourceRequestStatus(GetResourceRequestStatusRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetResourceRequestStatus operation.
///
///
/// The IAsyncResult returned by the call to BeginGetResourceRequestStatus.
///
/// Returns a GetResourceRequestStatusResult from CloudControlApi.
/// REST API Reference for GetResourceRequestStatus Operation
GetResourceRequestStatusResponse EndGetResourceRequestStatus(IAsyncResult asyncResult);
#endregion
#region ListResourceRequests
///
/// 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 7 days.
///
///
///
/// Container for the necessary parameters to execute the ListResourceRequests service method.
///
/// The response from the ListResourceRequests service method, as returned by CloudControlApi.
/// REST API Reference for ListResourceRequests Operation
ListResourceRequestsResponse ListResourceRequests(ListResourceRequestsRequest request);
///
/// Initiates the asynchronous execution of the ListResourceRequests operation.
///
///
/// Container for the necessary parameters to execute the ListResourceRequests operation on AmazonCloudControlApiClient.
/// 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 EndListResourceRequests
/// operation.
/// REST API Reference for ListResourceRequests Operation
IAsyncResult BeginListResourceRequests(ListResourceRequestsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListResourceRequests operation.
///
///
/// The IAsyncResult returned by the call to BeginListResourceRequests.
///
/// Returns a ListResourceRequestsResult from CloudControlApi.
/// REST API Reference for ListResourceRequests Operation
ListResourceRequestsResponse EndListResourceRequests(IAsyncResult asyncResult);
#endregion
#region ListResources
///
/// 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 those resources were provisioned using Cloud
/// Control API.
///
///
/// Container for the necessary parameters to execute the ListResources service method.
///
/// The response from the ListResources service method, as returned by CloudControlApi.
///
/// The resource with the name requested already exists.
///
///
/// The resource handler has returned that the downstream service generated an error that
/// doesn't map to any other handler error code.
///
///
/// The resource handler has failed without a returning a more specific error code. This
/// can include timeouts.
///
///
/// The resource handler has returned that an unexpected error occurred within the resource
/// handler.
///
///
/// The resource handler has returned that the credentials provided by the user are invalid.
///
///
/// The resource handler has returned that invalid input from the user has generated a
/// generic exception.
///
///
/// The resource handler has returned that the request couldn't be completed due to networking
/// issues, such as a failure to receive a response from the server.
///
///
/// The resource handler has returned that the downstream resource failed to complete
/// all of its ready-state checks.
///
///
/// One or more properties included in this resource operation are defined as create-only,
/// and therefore can't be updated.
///
///
/// Cloud Control API hasn't received a valid response from the resource handler, due
/// to a configuration error. This includes issues such as the resource handler returning
/// an invalid response, or timing out.
///
///
/// The resource is temporarily unavailable to be acted upon. For example, if the resource
/// is currently undergoing an operation and can't be acted upon until that operation
/// is finished.
///
///
/// A resource with the specified identifier can't be found.
///
///
/// The resource handler has returned that the downstream service returned an internal
/// error, typically with a 5XX HTTP status code.
///
///
/// The resource handler has returned that a non-transient resource limit was reached
/// on the service side.
///
///
/// The request was denied due to request throttling.
///
///
/// The specified extension doesn't exist in the CloudFormation registry.
///
///
/// The specified resource doesn't support this resource operation.
///
/// REST API Reference for ListResources Operation
ListResourcesResponse ListResources(ListResourcesRequest request);
///
/// Initiates the asynchronous execution of the ListResources operation.
///
///
/// Container for the necessary parameters to execute the ListResources operation on AmazonCloudControlApiClient.
/// 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 EndListResources
/// operation.
/// REST API Reference for ListResources Operation
IAsyncResult BeginListResources(ListResourcesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListResources operation.
///
///
/// The IAsyncResult returned by the call to BeginListResources.
///
/// Returns a ListResourcesResult from CloudControlApi.
/// REST API Reference for ListResources Operation
ListResourcesResponse EndListResources(IAsyncResult asyncResult);
#endregion
#region UpdateResource
///
/// 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 CloudFormation Users Guide.
///
///
/// Container for the necessary parameters to execute the UpdateResource service method.
///
/// The response from the UpdateResource service method, as returned by CloudControlApi.
///
/// The resource with the name requested already exists.
///
///
/// The specified client token has already been used in another resource request.
///
///
///
/// It's best practice for client tokens to be unique for each resource operation request.
/// However, client token expire after 36 hours.
///
///
///
/// Another resource operation is currently being performed on this resource.
///
///
/// The resource handler has returned that the downstream service generated an error that
/// doesn't map to any other handler error code.
///
///
/// The resource handler has failed without a returning a more specific error code. This
/// can include timeouts.
///
///
/// The resource handler has returned that an unexpected error occurred within the resource
/// handler.
///
///
/// The resource handler has returned that the credentials provided by the user are invalid.
///
///
/// The resource handler has returned that invalid input from the user has generated a
/// generic exception.
///
///
/// The resource handler has returned that the request couldn't be completed due to networking
/// issues, such as a failure to receive a response from the server.
///
///
/// The resource handler has returned that the downstream resource failed to complete
/// all of its ready-state checks.
///
///
/// One or more properties included in this resource operation are defined as create-only,
/// and therefore can't be updated.
///
///
/// Cloud Control API hasn't received a valid response from the resource handler, due
/// to a configuration error. This includes issues such as the resource handler returning
/// an invalid response, or timing out.
///
///
/// The resource is temporarily unavailable to be acted upon. For example, if the resource
/// is currently undergoing an operation and can't be acted upon until that operation
/// is finished.
///
///
/// A resource with the specified identifier can't be found.
///
///
/// The resource handler has returned that the downstream service returned an internal
/// error, typically with a 5XX HTTP status code.
///
///
/// The resource handler has returned that a non-transient resource limit was reached
/// on the service side.
///
///
/// The request was denied due to request throttling.
///
///
/// The specified extension doesn't exist in the CloudFormation registry.
///
///
/// The specified resource doesn't support this resource operation.
///
/// REST API Reference for UpdateResource Operation
UpdateResourceResponse UpdateResource(UpdateResourceRequest request);
///
/// Initiates the asynchronous execution of the UpdateResource operation.
///
///
/// Container for the necessary parameters to execute the UpdateResource operation on AmazonCloudControlApiClient.
/// 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 EndUpdateResource
/// operation.
/// REST API Reference for UpdateResource Operation
IAsyncResult BeginUpdateResource(UpdateResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateResource.
///
/// Returns a UpdateResourceResult from CloudControlApi.
/// REST API Reference for UpdateResource Operation
UpdateResourceResponse EndUpdateResource(IAsyncResult asyncResult);
#endregion
}
}