/*
* 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.Threading;
using System.Threading.Tasks;
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:
///
/// -
///
/// CreateConnection, which creates a uniquely named connection that can be referenced
/// by services such as CodePipeline.
///
///
-
///
/// DeleteConnection, which deletes the specified connection.
///
///
-
///
/// GetConnection, which returns information about the connection, including the
/// connection status.
///
///
-
///
/// ListConnections, which lists the connections associated with your account.
///
///
///
/// You can work with hosts by calling:
///
/// -
///
/// CreateHost, which creates a host that represents the infrastructure where
/// your provider is installed.
///
///
-
///
/// DeleteHost, which deletes the specified host.
///
///
-
///
/// GetHost, which returns information about the host, including the setup status.
///
///
-
///
/// ListHosts, which lists the hosts associated with your account.
///
///
///
/// You can work with tags in AWS CodeStar Connections by calling the following:
///
/// -
///
/// ListTagsForResource, which gets information about AWS tags for a specified
/// Amazon Resource Name (ARN) in AWS CodeStar Connections.
///
///
-
///
/// TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.
///
///
-
///
/// UntagResource, which removes tags for a resource in AWS CodeStar Connections.
///
///
///
/// For information about how to use AWS CodeStar Connections, see the Developer
/// Tools User Guide.
///
///
public partial interface IAmazonCodeStarconnections : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
ICodeStarconnectionsPaginatorFactory Paginators { get; }
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateConnectionAsync(CreateConnectionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateHost service method, as returned by CodeStarconnections.
///
/// Exceeded the maximum limit for connections.
///
/// REST API Reference for CreateHost Operation
Task CreateHostAsync(CreateHostRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// The connection to be deleted.
///
/// Container for the necessary parameters to execute the DeleteConnection service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteConnectionAsync(DeleteConnectionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteHostAsync(DeleteHostRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Returns the connection ARN and details such as status, owner, and provider type.
///
/// Container for the necessary parameters to execute the GetConnection service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetConnectionAsync(GetConnectionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetHostAsync(GetHostRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Lists the connections associated with your account.
///
/// Container for the necessary parameters to execute the ListConnections service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListConnections service method, as returned by CodeStarconnections.
/// REST API Reference for ListConnections Operation
Task ListConnectionsAsync(ListConnectionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Lists the hosts associated with your account.
///
/// Container for the necessary parameters to execute the ListHosts service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListHosts service method, as returned by CodeStarconnections.
/// REST API Reference for ListHosts Operation
Task ListHostsAsync(ListHostsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Removes tags from an AWS resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Updates a specified host with the provided configurations.
///
/// Container for the necessary parameters to execute the UpdateHost service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateHostAsync(UpdateHostRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}