github.com/aavshr/aws-sdk-go@v1.41.3/service/codestarconnections/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package codestarconnections provides the client and types for making API
     4  // requests to AWS CodeStar connections.
     5  //
     6  // This AWS CodeStar Connections API Reference provides descriptions and usage
     7  // examples of the operations and data types for the AWS CodeStar Connections
     8  // API. You can use the connections API to work with connections and installations.
     9  //
    10  // Connections are configurations that you use to connect AWS resources to external
    11  // code repositories. Each connection is a resource that can be given to services
    12  // such as CodePipeline to connect to a third-party repository such as Bitbucket.
    13  // For example, you can add the connection in CodePipeline so that it triggers
    14  // your pipeline when a code change is made to your third-party code repository.
    15  // Each connection is named and associated with a unique ARN that is used to
    16  // reference the connection.
    17  //
    18  // When you create a connection, the console initiates a third-party connection
    19  // handshake. Installations are the apps that are used to conduct this handshake.
    20  // For example, the installation for the Bitbucket provider type is the Bitbucket
    21  // app. When you create a connection, you can choose an existing installation
    22  // or create one.
    23  //
    24  // When you want to create a connection to an installed provider type such as
    25  // GitHub Enterprise Server, you create a host for your connections.
    26  //
    27  // You can work with connections by calling:
    28  //
    29  //    * CreateConnection, which creates a uniquely named connection that can
    30  //    be referenced by services such as CodePipeline.
    31  //
    32  //    * DeleteConnection, which deletes the specified connection.
    33  //
    34  //    * GetConnection, which returns information about the connection, including
    35  //    the connection status.
    36  //
    37  //    * ListConnections, which lists the connections associated with your account.
    38  //
    39  // You can work with hosts by calling:
    40  //
    41  //    * CreateHost, which creates a host that represents the infrastructure
    42  //    where your provider is installed.
    43  //
    44  //    * DeleteHost, which deletes the specified host.
    45  //
    46  //    * GetHost, which returns information about the host, including the setup
    47  //    status.
    48  //
    49  //    * ListHosts, which lists the hosts associated with your account.
    50  //
    51  // You can work with tags in AWS CodeStar Connections by calling the following:
    52  //
    53  //    * ListTagsForResource, which gets information about AWS tags for a specified
    54  //    Amazon Resource Name (ARN) in AWS CodeStar Connections.
    55  //
    56  //    * TagResource, which adds or updates tags for a resource in AWS CodeStar
    57  //    Connections.
    58  //
    59  //    * UntagResource, which removes tags for a resource in AWS CodeStar Connections.
    60  //
    61  // For information about how to use AWS CodeStar Connections, see the Developer
    62  // Tools User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html).
    63  //
    64  // See https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01 for more information on this service.
    65  //
    66  // See codestarconnections package documentation for more information.
    67  // https://docs.aws.amazon.com/sdk-for-go/api/service/codestarconnections/
    68  //
    69  // Using the Client
    70  //
    71  // To contact AWS CodeStar connections with the SDK use the New function to create
    72  // a new service client. With that client you can make API requests to the service.
    73  // These clients are safe to use concurrently.
    74  //
    75  // See the SDK's documentation for more information on how to use the SDK.
    76  // https://docs.aws.amazon.com/sdk-for-go/api/
    77  //
    78  // See aws.Config documentation for more information on configuring SDK clients.
    79  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    80  //
    81  // See the AWS CodeStar connections client CodeStarConnections for more
    82  // information on creating client for this service.
    83  // https://docs.aws.amazon.com/sdk-for-go/api/service/codestarconnections/#New
    84  package codestarconnections