/* * 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 codestar-connections-2019-12-01.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.CodeStarconnections.Model; namespace Amazon.CodeStarconnections { /// /// Interface for accessing CodeStarconnections /// /// AWS CodeStar Connections /// /// This AWS CodeStar Connections API Reference provides descriptions and usage examples /// of the operations and data types for the AWS CodeStar Connections API. You can use /// the connections API to work with connections and installations. /// /// /// /// Connections are configurations that you use to connect AWS resources to external /// code repositories. Each connection is a resource that can be given to services such /// as CodePipeline to connect to a third-party repository such as Bitbucket. For example, /// you can add the connection in CodePipeline so that it triggers your pipeline when /// a code change is made to your third-party code repository. Each connection is named /// and associated with a unique ARN that is used to reference the connection. /// /// /// /// When you create a connection, the console initiates a third-party connection handshake. /// Installations are the apps that are used to conduct this handshake. For example, /// the installation for the Bitbucket provider type is the Bitbucket app. When you create /// a connection, you can choose an existing installation or create one. /// /// /// /// When you want to create a connection to an installed provider type such as GitHub /// Enterprise Server, you create a host for your connections. /// /// /// /// You can work with connections by calling: /// /// /// /// You can work with hosts by calling: /// /// /// /// You can work with tags in AWS CodeStar Connections by calling the following: /// /// /// /// For information about how to use AWS CodeStar Connections, see the Developer /// Tools User Guide. /// /// public partial interface IAmazonCodeStarconnections : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ICodeStarconnectionsPaginatorFactory Paginators { get; } #endif #region CreateConnection /// /// Creates a connection that can then be given to other AWS services like CodePipeline /// so that it can access third-party code repositories. The connection is in pending /// status until the third-party connection handshake is completed from the console. /// /// Container for the necessary parameters to execute the CreateConnection service method. /// /// The response from the CreateConnection service method, as returned by CodeStarconnections. /// /// Exceeded the maximum limit for connections. /// /// /// Resource not found. Verify the connection resource ARN and try again. /// /// /// Resource not found. Verify the ARN for the host resource and try again. /// /// REST API Reference for CreateConnection Operation CreateConnectionResponse CreateConnection(CreateConnectionRequest request); /// /// Initiates the asynchronous execution of the CreateConnection operation. /// /// /// Container for the necessary parameters to execute the CreateConnection operation on AmazonCodeStarconnectionsClient. /// 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 EndCreateConnection /// operation. /// REST API Reference for CreateConnection Operation IAsyncResult BeginCreateConnection(CreateConnectionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateConnection operation. /// /// /// The IAsyncResult returned by the call to BeginCreateConnection. /// /// Returns a CreateConnectionResult from CodeStarconnections. /// REST API Reference for CreateConnection Operation CreateConnectionResponse EndCreateConnection(IAsyncResult asyncResult); #endregion #region CreateHost /// /// Creates a resource that represents the infrastructure where a third-party provider /// is installed. The host is used when you create connections to an installed third-party /// provider type, such as GitHub Enterprise Server. You create one host for all connections /// to that provider. /// /// /// /// A host created through the CLI or the SDK is in `PENDING` status by default. You can /// make its status `AVAILABLE` by setting up the host in the console. /// /// /// /// Container for the necessary parameters to execute the CreateHost service method. /// /// The response from the CreateHost service method, as returned by CodeStarconnections. /// /// Exceeded the maximum limit for connections. /// /// REST API Reference for CreateHost Operation CreateHostResponse CreateHost(CreateHostRequest request); /// /// Initiates the asynchronous execution of the CreateHost operation. /// /// /// Container for the necessary parameters to execute the CreateHost operation on AmazonCodeStarconnectionsClient. /// 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 EndCreateHost /// operation. /// REST API Reference for CreateHost Operation IAsyncResult BeginCreateHost(CreateHostRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateHost operation. /// /// /// The IAsyncResult returned by the call to BeginCreateHost. /// /// Returns a CreateHostResult from CodeStarconnections. /// REST API Reference for CreateHost Operation CreateHostResponse EndCreateHost(IAsyncResult asyncResult); #endregion #region DeleteConnection /// /// The connection to be deleted. /// /// Container for the necessary parameters to execute the DeleteConnection service method. /// /// The response from the DeleteConnection service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// REST API Reference for DeleteConnection Operation DeleteConnectionResponse DeleteConnection(DeleteConnectionRequest request); /// /// Initiates the asynchronous execution of the DeleteConnection operation. /// /// /// Container for the necessary parameters to execute the DeleteConnection operation on AmazonCodeStarconnectionsClient. /// 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 EndDeleteConnection /// operation. /// REST API Reference for DeleteConnection Operation IAsyncResult BeginDeleteConnection(DeleteConnectionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteConnection operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteConnection. /// /// Returns a DeleteConnectionResult from CodeStarconnections. /// REST API Reference for DeleteConnection Operation DeleteConnectionResponse EndDeleteConnection(IAsyncResult asyncResult); #endregion #region DeleteHost /// /// The host to be deleted. Before you delete a host, all connections associated to the /// host must be deleted. /// /// /// /// A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING /// state. /// /// /// /// Container for the necessary parameters to execute the DeleteHost service method. /// /// The response from the DeleteHost service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// /// Resource not found. Verify the ARN for the host resource and try again. /// /// REST API Reference for DeleteHost Operation DeleteHostResponse DeleteHost(DeleteHostRequest request); /// /// Initiates the asynchronous execution of the DeleteHost operation. /// /// /// Container for the necessary parameters to execute the DeleteHost operation on AmazonCodeStarconnectionsClient. /// 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 EndDeleteHost /// operation. /// REST API Reference for DeleteHost Operation IAsyncResult BeginDeleteHost(DeleteHostRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteHost operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteHost. /// /// Returns a DeleteHostResult from CodeStarconnections. /// REST API Reference for DeleteHost Operation DeleteHostResponse EndDeleteHost(IAsyncResult asyncResult); #endregion #region GetConnection /// /// Returns the connection ARN and details such as status, owner, and provider type. /// /// Container for the necessary parameters to execute the GetConnection service method. /// /// The response from the GetConnection service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// /// Resource not found. Verify the ARN for the host resource and try again. /// /// REST API Reference for GetConnection Operation GetConnectionResponse GetConnection(GetConnectionRequest request); /// /// Initiates the asynchronous execution of the GetConnection operation. /// /// /// Container for the necessary parameters to execute the GetConnection operation on AmazonCodeStarconnectionsClient. /// 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 EndGetConnection /// operation. /// REST API Reference for GetConnection Operation IAsyncResult BeginGetConnection(GetConnectionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetConnection operation. /// /// /// The IAsyncResult returned by the call to BeginGetConnection. /// /// Returns a GetConnectionResult from CodeStarconnections. /// REST API Reference for GetConnection Operation GetConnectionResponse EndGetConnection(IAsyncResult asyncResult); #endregion #region GetHost /// /// Returns the host ARN and details such as status, provider type, endpoint, and, if /// applicable, the VPC configuration. /// /// Container for the necessary parameters to execute the GetHost service method. /// /// The response from the GetHost service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// /// Resource not found. Verify the ARN for the host resource and try again. /// /// REST API Reference for GetHost Operation GetHostResponse GetHost(GetHostRequest request); /// /// Initiates the asynchronous execution of the GetHost operation. /// /// /// Container for the necessary parameters to execute the GetHost operation on AmazonCodeStarconnectionsClient. /// 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 EndGetHost /// operation. /// REST API Reference for GetHost Operation IAsyncResult BeginGetHost(GetHostRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetHost operation. /// /// /// The IAsyncResult returned by the call to BeginGetHost. /// /// Returns a GetHostResult from CodeStarconnections. /// REST API Reference for GetHost Operation GetHostResponse EndGetHost(IAsyncResult asyncResult); #endregion #region ListConnections /// /// Lists the connections associated with your account. /// /// Container for the necessary parameters to execute the ListConnections service method. /// /// The response from the ListConnections service method, as returned by CodeStarconnections. /// REST API Reference for ListConnections Operation ListConnectionsResponse ListConnections(ListConnectionsRequest request); /// /// Initiates the asynchronous execution of the ListConnections operation. /// /// /// Container for the necessary parameters to execute the ListConnections operation on AmazonCodeStarconnectionsClient. /// 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 EndListConnections /// operation. /// REST API Reference for ListConnections Operation IAsyncResult BeginListConnections(ListConnectionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListConnections operation. /// /// /// The IAsyncResult returned by the call to BeginListConnections. /// /// Returns a ListConnectionsResult from CodeStarconnections. /// REST API Reference for ListConnections Operation ListConnectionsResponse EndListConnections(IAsyncResult asyncResult); #endregion #region ListHosts /// /// Lists the hosts associated with your account. /// /// Container for the necessary parameters to execute the ListHosts service method. /// /// The response from the ListHosts service method, as returned by CodeStarconnections. /// REST API Reference for ListHosts Operation ListHostsResponse ListHosts(ListHostsRequest request); /// /// Initiates the asynchronous execution of the ListHosts operation. /// /// /// Container for the necessary parameters to execute the ListHosts operation on AmazonCodeStarconnectionsClient. /// 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 EndListHosts /// operation. /// REST API Reference for ListHosts Operation IAsyncResult BeginListHosts(ListHostsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListHosts operation. /// /// /// The IAsyncResult returned by the call to BeginListHosts. /// /// Returns a ListHostsResult from CodeStarconnections. /// REST API Reference for ListHosts Operation ListHostsResponse EndListHosts(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Gets the set of key-value pairs (metadata) that are used to manage the resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonCodeStarconnectionsClient. /// 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 EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from CodeStarconnections. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds to or modifies the tags of the given resource. Tags are metadata that can be /// used to manage a resource. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by CodeStarconnections. /// /// Exceeded the maximum limit for connections. /// /// /// Resource not found. Verify the connection resource ARN and try again. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonCodeStarconnectionsClient. /// 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 EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from CodeStarconnections. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes tags from an AWS resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by CodeStarconnections. /// /// Resource not found. Verify the connection resource ARN and try again. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonCodeStarconnectionsClient. /// 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 EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from CodeStarconnections. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateHost /// /// Updates a specified host with the provided configurations. /// /// Container for the necessary parameters to execute the UpdateHost service method. /// /// The response from the UpdateHost service method, as returned by CodeStarconnections. /// /// Two conflicting operations have been made on the same resource. /// /// /// Resource not found. Verify the connection resource ARN and try again. /// /// /// Resource not found. Verify the ARN for the host resource and try again. /// /// /// The operation is not supported. Check the connection status and try again. /// /// REST API Reference for UpdateHost Operation UpdateHostResponse UpdateHost(UpdateHostRequest request); /// /// Initiates the asynchronous execution of the UpdateHost operation. /// /// /// Container for the necessary parameters to execute the UpdateHost operation on AmazonCodeStarconnectionsClient. /// 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 EndUpdateHost /// operation. /// REST API Reference for UpdateHost Operation IAsyncResult BeginUpdateHost(UpdateHostRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateHost operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateHost. /// /// Returns a UpdateHostResult from CodeStarconnections. /// REST API Reference for UpdateHost Operation UpdateHostResponse EndUpdateHost(IAsyncResult asyncResult); #endregion } }