codestarconnections

package
v1.32.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 26, 2020 License: Apache-2.0 Imports: 9 Imported by: 22

Documentation

Overview

Package codestarconnections provides the client and types for making API requests to 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 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).

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 contact 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 CodeStarConnections for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codestarconnections/#New

Index

Constants

View Source 
const (
	// ConnectionStatusPending is a ConnectionStatus enum value
	ConnectionStatusPending = "PENDING"

	// ConnectionStatusAvailable is a ConnectionStatus enum value
	ConnectionStatusAvailable = "AVAILABLE"

	// ConnectionStatusError is a ConnectionStatus enum value
	ConnectionStatusError = "ERROR"
)
View Source 
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"
)
View Source 
const (
	ServiceName = "CodeStar connections" // Name of service.
	EndpointsID = "codestar-connections" // ID to lookup a service endpoint with.
	ServiceID   = "CodeStar connections" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ProviderTypeBitbucket is a ProviderType enum value
	ProviderTypeBitbucket = "Bitbucket"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CodeStarConnections 

type CodeStarConnections struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CodeStarConnections

New creates a new instance of the CodeStarConnections client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a CodeStarConnections client from just a session.
svc := codestarconnections.New(mySession)

// Create a CodeStarConnections client with additional configuration
svc := codestarconnections.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CodeStarConnections) CreateConnection 

func (c *CodeStarConnections) CreateConnection(input *CreateConnectionInput) (*CreateConnectionOutput, error)

CreateConnection 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation CreateConnection for usage and error information.

Returned Error Types:

  • LimitExceededException Exceeded the maximum limit for connections.

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

func (*CodeStarConnections) CreateConnectionRequest 

func (c *CodeStarConnections) CreateConnectionRequest(input *CreateConnectionInput) (req *request.Request, output *CreateConnectionOutput)

CreateConnectionRequest generates a "aws/request.Request" representing the client's request for the CreateConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConnection for more information on using the CreateConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateConnectionRequest method.
req, resp := client.CreateConnectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) CreateConnectionWithContext 

func (c *CodeStarConnections) CreateConnectionWithContext(ctx aws.Context, input *CreateConnectionInput, opts ...request.Option) (*CreateConnectionOutput, error)

CreateConnectionWithContext is the same as CreateConnection with the addition of the ability to pass a context and additional request options.

See CreateConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) DeleteConnection 

func (c *CodeStarConnections) DeleteConnection(input *DeleteConnectionInput) (*DeleteConnectionOutput, error)

DeleteConnection API operation for AWS CodeStar connections.

The connection to be deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation DeleteConnection for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.

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

func (*CodeStarConnections) DeleteConnectionRequest 

func (c *CodeStarConnections) DeleteConnectionRequest(input *DeleteConnectionInput) (req *request.Request, output *DeleteConnectionOutput)

DeleteConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConnection for more information on using the DeleteConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteConnectionRequest method.
req, resp := client.DeleteConnectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) DeleteConnectionWithContext 

func (c *CodeStarConnections) DeleteConnectionWithContext(ctx aws.Context, input *DeleteConnectionInput, opts ...request.Option) (*DeleteConnectionOutput, error)

DeleteConnectionWithContext is the same as DeleteConnection with the addition of the ability to pass a context and additional request options.

See DeleteConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) GetConnection 

func (c *CodeStarConnections) GetConnection(input *GetConnectionInput) (*GetConnectionOutput, error)

GetConnection API operation for AWS CodeStar connections.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation GetConnection for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.

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

func (*CodeStarConnections) GetConnectionRequest 

func (c *CodeStarConnections) GetConnectionRequest(input *GetConnectionInput) (req *request.Request, output *GetConnectionOutput)

GetConnectionRequest generates a "aws/request.Request" representing the client's request for the GetConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConnection for more information on using the GetConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetConnectionRequest method.
req, resp := client.GetConnectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) GetConnectionWithContext 

func (c *CodeStarConnections) GetConnectionWithContext(ctx aws.Context, input *GetConnectionInput, opts ...request.Option) (*GetConnectionOutput, error)

GetConnectionWithContext is the same as GetConnection with the addition of the ability to pass a context and additional request options.

See GetConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) ListConnections 

func (c *CodeStarConnections) ListConnections(input *ListConnectionsInput) (*ListConnectionsOutput, error)

ListConnections API operation for AWS CodeStar connections.

Lists the connections associated with your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation ListConnections for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/ListConnections

func (*CodeStarConnections) ListConnectionsPages 

func (c *CodeStarConnections) ListConnectionsPages(input *ListConnectionsInput, fn func(*ListConnectionsOutput, bool) bool) error

ListConnectionsPages iterates over the pages of a ListConnections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConnections method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListConnections operation.
pageNum := 0
err := client.ListConnectionsPages(params,
    func(page *codestarconnections.ListConnectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CodeStarConnections) ListConnectionsPagesWithContext 

func (c *CodeStarConnections) ListConnectionsPagesWithContext(ctx aws.Context, input *ListConnectionsInput, fn func(*ListConnectionsOutput, bool) bool, opts ...request.Option) error

ListConnectionsPagesWithContext same as ListConnectionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) ListConnectionsRequest 

func (c *CodeStarConnections) ListConnectionsRequest(input *ListConnectionsInput) (req *request.Request, output *ListConnectionsOutput)

ListConnectionsRequest generates a "aws/request.Request" representing the client's request for the ListConnections operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConnections for more information on using the ListConnections API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListConnectionsRequest method.
req, resp := client.ListConnectionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) ListConnectionsWithContext 

func (c *CodeStarConnections) ListConnectionsWithContext(ctx aws.Context, input *ListConnectionsInput, opts ...request.Option) (*ListConnectionsOutput, error)

ListConnectionsWithContext is the same as ListConnections with the addition of the ability to pass a context and additional request options.

See ListConnections for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) ListTagsForResource added in v1.30.22 

func (c *CodeStarConnections) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS CodeStar connections.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.

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

func (*CodeStarConnections) ListTagsForResourceRequest added in v1.30.22 

func (c *CodeStarConnections) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) ListTagsForResourceWithContext added in v1.30.22 

func (c *CodeStarConnections) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) TagResource added in v1.30.22 

func (c *CodeStarConnections) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.

  • LimitExceededException Exceeded the maximum limit for connections.

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

func (*CodeStarConnections) TagResourceRequest added in v1.30.22 

func (c *CodeStarConnections) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) TagResourceWithContext added in v1.30.22 

func (c *CodeStarConnections) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeStarConnections) UntagResource added in v1.30.22 

func (c *CodeStarConnections) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS CodeStar connections.

Removes tags from an AWS resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CodeStar connections's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.

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

func (*CodeStarConnections) UntagResourceRequest added in v1.30.22 

func (c *CodeStarConnections) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CodeStarConnections) UntagResourceWithContext added in v1.30.22 

func (c *CodeStarConnections) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 *string `type:"string" enum:"ConnectionStatus"`

	// 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. Currently, the valid provider type is Bitbucket.
	ProviderType *string `type:"string" enum:"ProviderType"`
	// contains filtered or unexported fields
}

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation is in `PENDING` status by default. You can make its status `AVAILABLE` by editing the connection in the CodePipeline console.

func (Connection) GoString 

func (s Connection) GoString() string

GoString returns the string representation

func (*Connection) SetConnectionArn 

func (s *Connection) SetConnectionArn(v string) *Connection

SetConnectionArn sets the ConnectionArn field's value.

func (*Connection) SetConnectionName 

func (s *Connection) SetConnectionName(v string) *Connection

SetConnectionName sets the ConnectionName field's value.

func (*Connection) SetConnectionStatus 

func (s *Connection) SetConnectionStatus(v string) *Connection

SetConnectionStatus sets the ConnectionStatus field's value.

func (*Connection) SetOwnerAccountId 

func (s *Connection) SetOwnerAccountId(v string) *Connection

SetOwnerAccountId sets the OwnerAccountId field's value.

func (*Connection) SetProviderType 

func (s *Connection) SetProviderType(v string) *Connection

SetProviderType sets the ProviderType field's value.

func (Connection) String 

func (s Connection) String() string

String returns the string representation

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 name of the external provider where your third-party code repository
	// is configured. Currently, the valid provider type is Bitbucket.
	//
	// ProviderType is a required field
	ProviderType *string `type:"string" required:"true" enum:"ProviderType"`

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

func (CreateConnectionInput) GoString 

func (s CreateConnectionInput) GoString() string

GoString returns the string representation

func (*CreateConnectionInput) SetConnectionName 

func (s *CreateConnectionInput) SetConnectionName(v string) *CreateConnectionInput

SetConnectionName sets the ConnectionName field's value.

func (*CreateConnectionInput) SetProviderType 

func (s *CreateConnectionInput) SetProviderType(v string) *CreateConnectionInput

SetProviderType sets the ProviderType field's value.

func (*CreateConnectionInput) SetTags added in v1.30.22 

func (s *CreateConnectionInput) SetTags(v []*Tag) *CreateConnectionInput

SetTags sets the Tags field's value.

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) GoString 

func (s CreateConnectionOutput) GoString() string

GoString returns the string representation

func (*CreateConnectionOutput) SetConnectionArn 

func (s *CreateConnectionOutput) SetConnectionArn(v string) *CreateConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*CreateConnectionOutput) SetTags added in v1.30.22 

func (s *CreateConnectionOutput) SetTags(v []*Tag) *CreateConnectionOutput

SetTags sets the Tags field's value.

func (CreateConnectionOutput) String 

func (s CreateConnectionOutput) String() string

String returns the string representation

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) GoString 

func (s DeleteConnectionInput) GoString() string

GoString returns the string representation

func (*DeleteConnectionInput) SetConnectionArn 

func (s *DeleteConnectionInput) SetConnectionArn(v string) *DeleteConnectionInput

SetConnectionArn sets the ConnectionArn field's value.

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) GoString 

func (s DeleteConnectionOutput) GoString() string

GoString returns the string representation

func (DeleteConnectionOutput) String 

func (s DeleteConnectionOutput) String() string

String returns the string representation

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) GoString 

func (s GetConnectionInput) GoString() string

GoString returns the string representation

func (*GetConnectionInput) SetConnectionArn 

func (s *GetConnectionInput) SetConnectionArn(v string) *GetConnectionInput

SetConnectionArn sets the ConnectionArn field's value.

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) GoString 

func (s GetConnectionOutput) GoString() string

GoString returns the string representation

func (*GetConnectionOutput) SetConnection 

func (s *GetConnectionOutput) SetConnection(v *Connection) *GetConnectionOutput

SetConnection sets the Connection field's value.

func (GetConnectionOutput) String 

func (s GetConnectionOutput) String() string

String returns the string representation

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Exceeded the maximum limit for connections.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation

type ListConnectionsInput 

type ListConnectionsInput 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 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 *string `type:"string" enum:"ProviderType"`
	// contains filtered or unexported fields
}

func (ListConnectionsInput) GoString 

func (s ListConnectionsInput) GoString() string

GoString returns the string representation

func (*ListConnectionsInput) SetMaxResults 

func (s *ListConnectionsInput) SetMaxResults(v int64) *ListConnectionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListConnectionsInput) SetNextToken 

func (s *ListConnectionsInput) SetNextToken(v string) *ListConnectionsInput

SetNextToken sets the NextToken field's value.

func (*ListConnectionsInput) SetProviderTypeFilter 

func (s *ListConnectionsInput) SetProviderTypeFilter(v string) *ListConnectionsInput

SetProviderTypeFilter sets the ProviderTypeFilter field's value.

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) GoString 

func (s ListConnectionsOutput) GoString() string

GoString returns the string representation

func (*ListConnectionsOutput) SetConnections 

func (s *ListConnectionsOutput) SetConnections(v []*Connection) *ListConnectionsOutput

SetConnections sets the Connections field's value.

func (*ListConnectionsOutput) SetNextToken 

func (s *ListConnectionsOutput) SetNextToken(v string) *ListConnectionsOutput

SetNextToken sets the NextToken field's value.

func (ListConnectionsOutput) String 

func (s ListConnectionsOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.30.22 

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) GoString added in v1.30.22 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.30.22 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.30.22 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.30.22 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.30.22 

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) GoString added in v1.30.22 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.30.22 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.30.22 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Resource not found. Verify the connection resource ARN and try again.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type Tag added in v1.30.22 

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) GoString added in v1.30.22 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.30.22 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.30.22 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.30.22 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.30.22 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.30.22 

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) GoString added in v1.30.22 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.30.22 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.30.22 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.30.22 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.30.22 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.30.22 

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

func (TagResourceOutput) GoString added in v1.30.22 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.30.22 

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput added in v1.30.22 

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) GoString added in v1.30.22 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.30.22 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.30.22 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.30.22 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.30.22 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.30.22 

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

func (UntagResourceOutput) GoString added in v1.30.22 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.30.22 

func (s UntagResourceOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package codestarconnectionsiface provides an interface to enable mocking the AWS CodeStar connections service client for testing your code.
 Package codestarconnectionsiface provides an interface to enable mocking the AWS CodeStar connections service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.