/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::CodeStarConnections

NAME

Paws::CodeStarConnections - Perl Interface to AWS AWS CodeStar connections

SYNOPSIS

use Paws;

my $obj = Paws->service('CodeStarConnections');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

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 Cloud app. When you create a connection, you can choose an existing installation or create one.

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.

For information about how to use AWS CodeStar Connections, see the AWS CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01

METHODS

CreateConnection

ConnectionName => Str
ProviderType => Str

Each argument is described in detail in: Paws::CodeStarConnections::CreateConnection

Returns: a Paws::CodeStarConnections::CreateConnectionOutput instance

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.

DeleteConnection

ConnectionArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::DeleteConnection

Returns: a Paws::CodeStarConnections::DeleteConnectionOutput instance

The connection to be deleted.

GetConnection

ConnectionArn => Str

Each argument is described in detail in: Paws::CodeStarConnections::GetConnection

Returns: a Paws::CodeStarConnections::GetConnectionOutput instance

Returns the connection ARN and details such as status, owner, and provider type.

ListConnections

[MaxResults => Int]
[NextToken => Str]
[ProviderTypeFilter => Str]

Each argument is described in detail in: Paws::CodeStarConnections::ListConnections

Returns: a Paws::CodeStarConnections::ListConnectionsOutput instance

Lists the connections associated with your account.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues