package codestarconnections

import "github.com/aws/aws-sdk-go-v2/service/codestarconnections"

Package codestarconnections provides the client and types for making API requests to AWS CodeStar connections.

The CodeStar Connections feature is in preview release and is subject to change.

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.

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 (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html).

See https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01 for more information on this service.

See codestarconnections package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/codestarconnections/

Using the Client

To use AWS CodeStar connections with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS CodeStar connections client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codestarconnections/#New

Index

Constants 

const (
	ServiceName = "AWS CodeStar connections" // Service's name
	ServiceID   = "CodeStarConnections"      // Service's identifier
	EndpointsID = "codestar-connections"     // Service's Endpoint identifier
)
const (

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Exceeded the maximum limit for connections.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Resource not found. Verify the connection resource ARN and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// Resource not found. Verify the ARN for the host resource and try again.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"
)

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS CodeStar connections. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := codestarconnections.New(myConfig)

func (*Client) CreateConnectionRequest 

func (c *Client) CreateConnectionRequest(input *CreateConnectionInput) CreateConnectionRequest

CreateConnectionRequest returns a request value for making API operation for AWS CodeStar connections.

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. 

// Example sending a request using CreateConnectionRequest.
req := client.CreateConnectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/CreateConnection

func (*Client) CreateHostRequest 

func (c *Client) CreateHostRequest(input *CreateHostInput) CreateHostRequest

CreateHostRequest returns a request value for making API operation for AWS CodeStar connections.

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. 

// Example sending a request using CreateHostRequest.
req := client.CreateHostRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/CreateHost

func (*Client) DeleteConnectionRequest 

func (c *Client) DeleteConnectionRequest(input *DeleteConnectionInput) DeleteConnectionRequest

DeleteConnectionRequest returns a request value for making API operation for AWS CodeStar connections.

The connection to be deleted. 

// Example sending a request using DeleteConnectionRequest.
req := client.DeleteConnectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/DeleteConnection

func (*Client) DeleteHostRequest 

func (c *Client) DeleteHostRequest(input *DeleteHostInput) DeleteHostRequest

DeleteHostRequest returns a request value for making API operation for AWS CodeStar connections.

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. 

// Example sending a request using DeleteHostRequest.
req := client.DeleteHostRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/DeleteHost

func (*Client) GetConnectionRequest 

func (c *Client) GetConnectionRequest(input *GetConnectionInput) GetConnectionRequest

GetConnectionRequest returns a request value for making API operation for AWS CodeStar connections.

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

// Example sending a request using GetConnectionRequest.
req := client.GetConnectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/GetConnection

func (*Client) GetHostRequest 

func (c *Client) GetHostRequest(input *GetHostInput) GetHostRequest

GetHostRequest returns a request value for making API operation for AWS CodeStar connections.

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration. 

// Example sending a request using GetHostRequest.
req := client.GetHostRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/GetHost

func (*Client) ListConnectionsRequest 

func (c *Client) ListConnectionsRequest(input *ListConnectionsInput) ListConnectionsRequest

ListConnectionsRequest returns a request value for making API operation for AWS CodeStar connections.

Lists the connections associated with your account. 

// Example sending a request using ListConnectionsRequest.
req := client.ListConnectionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/ListConnections

func (*Client) ListHostsRequest 

func (c *Client) ListHostsRequest(input *ListHostsInput) ListHostsRequest

ListHostsRequest returns a request value for making API operation for AWS CodeStar connections.

Lists the hosts associated with your account. 

// Example sending a request using ListHostsRequest.
req := client.ListHostsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/ListHosts

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS CodeStar connections.

Gets the set of key-value pairs (metadata) that are used to manage the resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/ListTagsForResource

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS CodeStar connections.

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS CodeStar connections.

Removes tags from an AWS resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/UntagResource

type Connection 

type Connection struct {

	// The Amazon Resource Name (ARN) of the connection. The ARN is used as the
	// connection reference when the connection is shared between AWS services.
	//
	// The ARN is never reused if the connection is deleted.
	ConnectionArn *string `type:"string"`

	// The name of the connection. Connection names must be unique in an AWS user
	// account.
	ConnectionName *string `min:"1" type:"string"`

	// The current status of the connection.
	ConnectionStatus ConnectionStatus `type:"string" enum:"true"`

	// The Amazon Resource Name (ARN) of the host associated with the connection.
	HostArn *string `type:"string"`

	// The identifier of the external provider where your third-party code repository
	// is configured. For Bitbucket, this is the account ID of the owner of the
	// Bitbucket repository.
	OwnerAccountId *string `min:"12" type:"string"`

	// The name of the external provider where your third-party code repository
	// is configured. The valid provider type is Bitbucket.
	ProviderType ProviderType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A resource that is used to connect third-party source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.

func (Connection) String 

func (s Connection) String() string

String returns the string representation

type ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusPending   ConnectionStatus = "PENDING"
	ConnectionStatusAvailable ConnectionStatus = "AVAILABLE"
	ConnectionStatusError     ConnectionStatus = "ERROR"
)

Enum values for ConnectionStatus

func (ConnectionStatus) MarshalValue 

func (enum ConnectionStatus) MarshalValue() (string, error)

func (ConnectionStatus) MarshalValueBuf 

func (enum ConnectionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CreateConnectionInput 

type CreateConnectionInput struct {

	// The name of the connection to be created. The name must be unique in the
	// calling AWS account.
	//
	// ConnectionName is a required field
	ConnectionName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the host associated with the connection
	// to be created.
	HostArn *string `type:"string"`

	// The name of the external provider where your third-party code repository
	// is configured. The valid provider type is Bitbucket.
	ProviderType ProviderType `type:"string" enum:"true"`

	// The key-value pair to use when tagging the resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateConnectionInput) String 

func (s CreateConnectionInput) String() string

String returns the string representation

func (*CreateConnectionInput) Validate 

func (s *CreateConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionOutput 

type CreateConnectionOutput struct {

	// The Amazon Resource Name (ARN) of the connection to be created. The ARN is
	// used as the connection reference when the connection is shared between AWS
	// services.
	//
	// The ARN is never reused if the connection is deleted.
	//
	// ConnectionArn is a required field
	ConnectionArn *string `type:"string" required:"true"`

	// Specifies the tags applied to the resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateConnectionOutput) String 

func (s CreateConnectionOutput) String() string

String returns the string representation

type CreateConnectionRequest 

type CreateConnectionRequest struct {
	*aws.Request
	Input *CreateConnectionInput
	Copy  func(*CreateConnectionInput) CreateConnectionRequest
}

CreateConnectionRequest is the request type for the CreateConnection API operation.

func (CreateConnectionRequest) Send 

func (r CreateConnectionRequest) Send(ctx context.Context) (*CreateConnectionResponse, error)

Send marshals and sends the CreateConnection API request.

type CreateConnectionResponse 

type CreateConnectionResponse struct {
	*CreateConnectionOutput
	// contains filtered or unexported fields
}

CreateConnectionResponse is the response type for the CreateConnection API operation.

func (*CreateConnectionResponse) SDKResponseMetdata 

func (r *CreateConnectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConnection request.

type CreateHostInput 

type CreateHostInput struct {

	// The name of the host to be created. The name must be unique in the calling
	// AWS account.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The endpoint of the infrastructure to be represented by the host after it
	// is created.
	//
	// ProviderEndpoint is a required field
	ProviderEndpoint *string `min:"1" type:"string" required:"true"`

	// The name of the installed provider to be associated with your connection.
	// The host resource represents the infrastructure where your provider type
	// is installed. The valid provider type is GitHub Enterprise Server.
	//
	// ProviderType is a required field
	ProviderType ProviderType `type:"string" required:"true" enum:"true"`

	// The VPC configuration to be provisioned for the host. A VPC must be configured
	// and the infrastructure to be represented by the host must already be connected
	// to the VPC.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateHostInput) String 

func (s CreateHostInput) String() string

String returns the string representation

func (*CreateHostInput) Validate 

func (s *CreateHostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateHostOutput 

type CreateHostOutput struct {

	// The Amazon Resource Name (ARN) of the host to be created.
	HostArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateHostOutput) String 

func (s CreateHostOutput) String() string

String returns the string representation

type CreateHostRequest 

type CreateHostRequest struct {
	*aws.Request
	Input *CreateHostInput
	Copy  func(*CreateHostInput) CreateHostRequest
}

CreateHostRequest is the request type for the CreateHost API operation.

func (CreateHostRequest) Send 

func (r CreateHostRequest) Send(ctx context.Context) (*CreateHostResponse, error)

Send marshals and sends the CreateHost API request.

type CreateHostResponse 

type CreateHostResponse struct {
	*CreateHostOutput
	// contains filtered or unexported fields
}

CreateHostResponse is the response type for the CreateHost API operation.

func (*CreateHostResponse) SDKResponseMetdata 

func (r *CreateHostResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateHost request.

type DeleteConnectionInput 

type DeleteConnectionInput struct {

	// The Amazon Resource Name (ARN) of the connection to be deleted.
	//
	// The ARN is never reused if the connection is deleted.
	//
	// ConnectionArn is a required field
	ConnectionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConnectionInput) String 

func (s DeleteConnectionInput) String() string

String returns the string representation

func (*DeleteConnectionInput) Validate 

func (s *DeleteConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConnectionOutput 

type DeleteConnectionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteConnectionOutput) String 

func (s DeleteConnectionOutput) String() string

String returns the string representation

type DeleteConnectionRequest 

type DeleteConnectionRequest struct {
	*aws.Request
	Input *DeleteConnectionInput
	Copy  func(*DeleteConnectionInput) DeleteConnectionRequest
}

DeleteConnectionRequest is the request type for the DeleteConnection API operation.

func (DeleteConnectionRequest) Send 

func (r DeleteConnectionRequest) Send(ctx context.Context) (*DeleteConnectionResponse, error)

Send marshals and sends the DeleteConnection API request.

type DeleteConnectionResponse 

type DeleteConnectionResponse struct {
	*DeleteConnectionOutput
	// contains filtered or unexported fields
}

DeleteConnectionResponse is the response type for the DeleteConnection API operation.

func (*DeleteConnectionResponse) SDKResponseMetdata 

func (r *DeleteConnectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteConnection request.

type DeleteHostInput 

type DeleteHostInput struct {

	// The Amazon Resource Name (ARN) of the host to be deleted.
	//
	// HostArn is a required field
	HostArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteHostInput) String 

func (s DeleteHostInput) String() string

String returns the string representation

func (*DeleteHostInput) Validate 

func (s *DeleteHostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHostOutput 

type DeleteHostOutput struct {
	// contains filtered or unexported fields
}

func (DeleteHostOutput) String 

func (s DeleteHostOutput) String() string

String returns the string representation

type DeleteHostRequest 

type DeleteHostRequest struct {
	*aws.Request
	Input *DeleteHostInput
	Copy  func(*DeleteHostInput) DeleteHostRequest
}

DeleteHostRequest is the request type for the DeleteHost API operation.

func (DeleteHostRequest) Send 

func (r DeleteHostRequest) Send(ctx context.Context) (*DeleteHostResponse, error)

Send marshals and sends the DeleteHost API request.

type DeleteHostResponse 

type DeleteHostResponse struct {
	*DeleteHostOutput
	// contains filtered or unexported fields
}

DeleteHostResponse is the response type for the DeleteHost API operation.

func (*DeleteHostResponse) SDKResponseMetdata 

func (r *DeleteHostResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteHost request.

type GetConnectionInput 

type GetConnectionInput struct {

	// The Amazon Resource Name (ARN) of a connection.
	//
	// ConnectionArn is a required field
	ConnectionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConnectionInput) String 

func (s GetConnectionInput) String() string

String returns the string representation

func (*GetConnectionInput) Validate 

func (s *GetConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConnectionOutput 

type GetConnectionOutput struct {

	// The connection details, such as status, owner, and provider type.
	Connection *Connection `type:"structure"`
	// contains filtered or unexported fields
}

func (GetConnectionOutput) String 

func (s GetConnectionOutput) String() string

String returns the string representation

type GetConnectionRequest 

type GetConnectionRequest struct {
	*aws.Request
	Input *GetConnectionInput
	Copy  func(*GetConnectionInput) GetConnectionRequest
}

GetConnectionRequest is the request type for the GetConnection API operation.

func (GetConnectionRequest) Send 

func (r GetConnectionRequest) Send(ctx context.Context) (*GetConnectionResponse, error)

Send marshals and sends the GetConnection API request.

type GetConnectionResponse 

type GetConnectionResponse struct {
	*GetConnectionOutput
	// contains filtered or unexported fields
}

GetConnectionResponse is the response type for the GetConnection API operation.

func (*GetConnectionResponse) SDKResponseMetdata 

func (r *GetConnectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetConnection request.

type GetHostInput 

type GetHostInput struct {

	// The Amazon Resource Name (ARN) of the requested host.
	//
	// HostArn is a required field
	HostArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetHostInput) String 

func (s GetHostInput) String() string

String returns the string representation

func (*GetHostInput) Validate 

func (s *GetHostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetHostOutput 

type GetHostOutput struct {

	// The name of the requested host.
	Name *string `min:"1" type:"string"`

	// The endpoint of the infrastructure represented by the requested host.
	ProviderEndpoint *string `min:"1" type:"string"`

	// The provider type of the requested host, such as GitHub Enterprise Server.
	ProviderType ProviderType `type:"string" enum:"true"`

	// The status of the requested host.
	Status *string `type:"string"`

	// The VPC configuration of the requested host.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetHostOutput) String 

func (s GetHostOutput) String() string

String returns the string representation

type GetHostRequest 

type GetHostRequest struct {
	*aws.Request
	Input *GetHostInput
	Copy  func(*GetHostInput) GetHostRequest
}

GetHostRequest is the request type for the GetHost API operation.

func (GetHostRequest) Send 

func (r GetHostRequest) Send(ctx context.Context) (*GetHostResponse, error)

Send marshals and sends the GetHost API request.

type GetHostResponse 

type GetHostResponse struct {
	*GetHostOutput
	// contains filtered or unexported fields
}

GetHostResponse is the response type for the GetHost API operation.

func (*GetHostResponse) SDKResponseMetdata 

func (r *GetHostResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetHost request.

type Host 

type Host struct {

	// The Amazon Resource Name (ARN) of the host.
	HostArn *string `type:"string"`

	// The name of the host.
	Name *string `min:"1" type:"string"`

	// The endpoint of the infrastructure where your provider type is installed.
	ProviderEndpoint *string `min:"1" type:"string"`

	// The name of the installed provider to be associated with your connection.
	// The host resource represents the infrastructure where your provider type
	// is installed. The valid provider type is GitHub Enterprise Server.
	ProviderType ProviderType `type:"string" enum:"true"`

	// The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING,
	// VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
	Status *string `type:"string"`

	// The status description for the host.
	StatusMessage *string `type:"string"`

	// The VPC configuration provisioned for the host.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (Host) String 

func (s Host) String() string

String returns the string representation

type ListConnectionsInput 

type ListConnectionsInput struct {

	// Filters the list of connections to those associated with a specified host.
	HostArnFilter *string `type:"string"`

	// The maximum number of results to return in a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int64 `type:"integer"`

	// The token that was returned from the previous ListConnections call, which
	// can be used to return the next set of connections in the list.
	NextToken *string `min:"1" type:"string"`

	// Filters the list of connections to those associated with a specified provider,
	// such as Bitbucket.
	ProviderTypeFilter ProviderType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListConnectionsInput) String 

func (s ListConnectionsInput) String() string

String returns the string representation

func (*ListConnectionsInput) Validate 

func (s *ListConnectionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConnectionsOutput 

type ListConnectionsOutput struct {

	// A list of connections and the details for each connection, such as status,
	// owner, and provider type.
	Connections []Connection `type:"list"`

	// A token that can be used in the next ListConnections call. To view all items
	// in the list, continue to call this operation with each subsequent token until
	// no more nextToken values are returned.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConnectionsOutput) String 

func (s ListConnectionsOutput) String() string

String returns the string representation

type ListConnectionsPaginator 

type ListConnectionsPaginator struct {
	aws.Pager
}

ListConnectionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListConnectionsPaginator 

func NewListConnectionsPaginator(req ListConnectionsRequest) ListConnectionsPaginator

NewListConnectionsRequestPaginator returns a paginator for ListConnections. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListConnectionsRequest(input)
p := codestarconnections.NewListConnectionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListConnectionsPaginator) CurrentPage 

func (p *ListConnectionsPaginator) CurrentPage() *ListConnectionsOutput

type ListConnectionsRequest 

type ListConnectionsRequest struct {
	*aws.Request
	Input *ListConnectionsInput
	Copy  func(*ListConnectionsInput) ListConnectionsRequest
}

ListConnectionsRequest is the request type for the ListConnections API operation.

func (ListConnectionsRequest) Send 

func (r ListConnectionsRequest) Send(ctx context.Context) (*ListConnectionsResponse, error)

Send marshals and sends the ListConnections API request.

type ListConnectionsResponse 

type ListConnectionsResponse struct {
	*ListConnectionsOutput
	// contains filtered or unexported fields
}

ListConnectionsResponse is the response type for the ListConnections API operation.

func (*ListConnectionsResponse) SDKResponseMetdata 

func (r *ListConnectionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListConnections request.

type ListHostsInput 

type ListHostsInput struct {

	// The maximum number of results to return in a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int64 `type:"integer"`

	// The token that was returned from the previous ListHosts call, which can be
	// used to return the next set of hosts in the list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListHostsInput) String 

func (s ListHostsInput) String() string

String returns the string representation

func (*ListHostsInput) Validate 

func (s *ListHostsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListHostsOutput 

type ListHostsOutput struct {

	// A list of hosts and the details for each host, such as status, endpoint,
	// and provider type.
	Hosts []Host `type:"list"`

	// A token that can be used in the next ListHosts call. To view all items in
	// the list, continue to call this operation with each subsequent token until
	// no more nextToken values are returned.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListHostsOutput) String 

func (s ListHostsOutput) String() string

String returns the string representation

type ListHostsPaginator 

type ListHostsPaginator struct {
	aws.Pager
}

ListHostsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListHostsPaginator 

func NewListHostsPaginator(req ListHostsRequest) ListHostsPaginator

NewListHostsRequestPaginator returns a paginator for ListHosts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListHostsRequest(input)
p := codestarconnections.NewListHostsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListHostsPaginator) CurrentPage 

func (p *ListHostsPaginator) CurrentPage() *ListHostsOutput

type ListHostsRequest 

type ListHostsRequest struct {
	*aws.Request
	Input *ListHostsInput
	Copy  func(*ListHostsInput) ListHostsRequest
}

ListHostsRequest is the request type for the ListHosts API operation.

func (ListHostsRequest) Send 

func (r ListHostsRequest) Send(ctx context.Context) (*ListHostsResponse, error)

Send marshals and sends the ListHosts API request.

type ListHostsResponse 

type ListHostsResponse struct {
	*ListHostsOutput
	// contains filtered or unexported fields
}

ListHostsResponse is the response type for the ListHosts API operation.

func (*ListHostsResponse) SDKResponseMetdata 

func (r *ListHostsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListHosts request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which you want to get
	// information about tags, if any.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of tag key and value pairs associated with the specified resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ProviderType 

type ProviderType string
const (
	ProviderTypeBitbucket              ProviderType = "Bitbucket"
	ProviderTypeGitHubEnterpriseServer ProviderType = "GitHubEnterpriseServer"
)

Enum values for ProviderType

func (ProviderType) MarshalValue 

func (enum ProviderType) MarshalValue() (string, error)

func (ProviderType) MarshalValueBuf 

func (enum ProviderType) MarshalValueBuf(b []byte) ([]byte, error)

type Tag 

type Tag struct {

	// The tag's key.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The tag's value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by AWS services that support tags.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which you want to add or
	// update tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The tags you want to modify or add to the resource.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to remove tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The list of keys for the tags to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type VpcConfiguration 

type VpcConfiguration struct {

	// The ID of the security group or security groups associated with the Amazon
	// VPC connected to the infrastructure where your provider type is installed.
	//
	// SecurityGroupIds is a required field
	SecurityGroupIds []string `min:"1" type:"list" required:"true"`

	// The ID of the subnet or subnets associated with the Amazon VPC connected
	// to the infrastructure where your provider type is installed.
	//
	// SubnetIds is a required field
	SubnetIds []string `min:"1" type:"list" required:"true"`

	// The value of the Transport Layer Security (TLS) certificate associated with
	// the infrastructure where your provider type is installed.
	TlsCertificate *string `min:"1" type:"string"`

	// The ID of the Amazon VPC connected to the infrastructure where your provider
	// type is installed.
	//
	// VpcId is a required field
	VpcId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The VPC configuration provisioned for the host.

func (VpcConfiguration) String 

func (s VpcConfiguration) String() string

String returns the string representation

func (*VpcConfiguration) Validate 

func (s *VpcConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

api_client.go api_doc.go api_enums.go api_errors.go api_op_CreateConnection.go api_op_CreateHost.go api_op_DeleteConnection.go api_op_DeleteHost.go api_op_GetConnection.go api_op_GetHost.go api_op_ListConnections.go api_op_ListHosts.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go api_types.go

Directories

PathSynopsis
service/codestarconnections/codestarconnectionsifacePackage codestarconnectionsiface provides an interface to enable mocking the AWS CodeStar connections service client for testing your code.
Version
v0.24.0
Published
Jul 22, 2020
Platform
windows/amd64
Imports
7 packages
Last checked
1 minute ago –

Tools for package owners.