codestarconnections

package
v1.38.26-0...-e443fa6 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

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

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

  • CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

  • DeleteConnection, which deletes the specified connection.

  • GetConnection, which returns information about the connection, including the connection status.

  • ListConnections, which lists the connections associated with your account.

You can work with hosts by calling:

  • CreateHost, which creates a host that represents the infrastructure where your provider is installed.

  • DeleteHost, which deletes the specified host.

  • GetHost, which returns information about the host, including the setup status.

  • ListHosts, which lists the hosts associated with your account.

You can work with tags in AWS CodeStar Connections by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

  • TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.

  • UntagResource, which removes tags for a resource in AWS CodeStar Connections.

For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide (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 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 (
	// ProviderTypeBitbucket is a ProviderType enum value
	ProviderTypeBitbucket = "Bitbucket"

	// ProviderTypeGitHub is a ProviderType enum value
	ProviderTypeGitHub = "GitHub"

	// ProviderTypeGitHubEnterpriseServer is a ProviderType enum value
	ProviderTypeGitHubEnterpriseServer = "GitHubEnterpriseServer"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Two conflicting operations have been made on the same resource.
	ErrCodeConflictException = "ConflictException"

	// 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"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// The operation is not supported. Check the connection status and try again.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)
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

Variables

This section is empty.

Functions

func ConnectionStatus_Values 

func ConnectionStatus_Values() []string

ConnectionStatus_Values returns all elements of the ConnectionStatus enum

func ProviderType_Values 

func ProviderType_Values() []string

ProviderType_Values returns all elements of the ProviderType enum

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.

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

  • ResourceUnavailableException Resource not found. Verify the ARN for the host resource and try again.

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

func (c *CodeStarConnections) CreateHost(input *CreateHostInput) (*CreateHostOutput, error)

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

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 CreateHost 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/CreateHost

func (*CodeStarConnections) CreateHostRequest 

func (c *CodeStarConnections) CreateHostRequest(input *CreateHostInput) (req *request.Request, output *CreateHostOutput)

CreateHostRequest generates a "aws/request.Request" representing the client's request for the CreateHost 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 CreateHost for more information on using the CreateHost 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 CreateHostRequest method.
req, resp := client.CreateHostRequest(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/CreateHost

func (*CodeStarConnections) CreateHostWithContext 

func (c *CodeStarConnections) CreateHostWithContext(ctx aws.Context, input *CreateHostInput, opts ...request.Option) (*CreateHostOutput, error)

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

See CreateHost 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) DeleteHost 

func (c *CodeStarConnections) DeleteHost(input *DeleteHostInput) (*DeleteHostOutput, error)

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

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 DeleteHost for usage and error information.

Returned Error Types:

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

  • ResourceUnavailableException Resource not found. Verify the ARN for the host resource and try again.

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

func (*CodeStarConnections) DeleteHostRequest 

func (c *CodeStarConnections) DeleteHostRequest(input *DeleteHostInput) (req *request.Request, output *DeleteHostOutput)

DeleteHostRequest generates a "aws/request.Request" representing the client's request for the DeleteHost 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 DeleteHost for more information on using the DeleteHost 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 DeleteHostRequest method.
req, resp := client.DeleteHostRequest(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/DeleteHost

func (*CodeStarConnections) DeleteHostWithContext 

func (c *CodeStarConnections) DeleteHostWithContext(ctx aws.Context, input *DeleteHostInput, opts ...request.Option) (*DeleteHostOutput, error)

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

See DeleteHost 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.

  • ResourceUnavailableException Resource not found. Verify the ARN for the host resource 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) GetHost 

func (c *CodeStarConnections) GetHost(input *GetHostInput) (*GetHostOutput, error)

GetHost API operation for AWS CodeStar connections.

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

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 GetHost for usage and error information.

Returned Error Types:

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

  • ResourceUnavailableException Resource not found. Verify the ARN for the host resource and try again.

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

func (*CodeStarConnections) GetHostRequest 

func (c *CodeStarConnections) GetHostRequest(input *GetHostInput) (req *request.Request, output *GetHostOutput)

GetHostRequest generates a "aws/request.Request" representing the client's request for the GetHost 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 GetHost for more information on using the GetHost 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 GetHostRequest method.
req, resp := client.GetHostRequest(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/GetHost

func (*CodeStarConnections) GetHostWithContext 

func (c *CodeStarConnections) GetHostWithContext(ctx aws.Context, input *GetHostInput, opts ...request.Option) (*GetHostOutput, error)

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

See GetHost 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) ListHosts 

func (c *CodeStarConnections) ListHosts(input *ListHostsInput) (*ListHostsOutput, error)

ListHosts API operation for AWS CodeStar connections.

Lists the hosts 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 ListHosts for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/ListHosts

func (*CodeStarConnections) ListHostsPages 

func (c *CodeStarConnections) ListHostsPages(input *ListHostsInput, fn func(*ListHostsOutput, bool) bool) error

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

See ListHosts 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 ListHosts operation.
pageNum := 0
err := client.ListHostsPages(params,
    func(page *codestarconnections.ListHostsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CodeStarConnections) ListHostsPagesWithContext 

func (c *CodeStarConnections) ListHostsPagesWithContext(ctx aws.Context, input *ListHostsInput, fn func(*ListHostsOutput, bool) bool, opts ...request.Option) error

ListHostsPagesWithContext same as ListHostsPages 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) ListHostsRequest 

func (c *CodeStarConnections) ListHostsRequest(input *ListHostsInput) (req *request.Request, output *ListHostsOutput)

ListHostsRequest generates a "aws/request.Request" representing the client's request for the ListHosts 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 ListHosts for more information on using the ListHosts 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 ListHostsRequest method.
req, resp := client.ListHostsRequest(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/ListHosts

func (*CodeStarConnections) ListHostsWithContext 

func (c *CodeStarConnections) ListHostsWithContext(ctx aws.Context, input *ListHostsInput, opts ...request.Option) (*ListHostsOutput, error)

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

See ListHosts 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 

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 

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 

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 

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 

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 

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 

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 

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 

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.

func (*CodeStarConnections) UpdateHost 

func (c *CodeStarConnections) UpdateHost(input *UpdateHostInput) (*UpdateHostOutput, error)

UpdateHost API operation for AWS CodeStar connections.

Updates a specified host with the provided configurations.

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 UpdateHost for usage and error information.

Returned Error Types:

  • ConflictException Two conflicting operations have been made on the same resource.

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

  • ResourceUnavailableException Resource not found. Verify the ARN for the host resource and try again.

  • UnsupportedOperationException The operation is not supported. Check the connection status and try again.

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

func (*CodeStarConnections) UpdateHostRequest 

func (c *CodeStarConnections) UpdateHostRequest(input *UpdateHostInput) (req *request.Request, output *UpdateHostOutput)

UpdateHostRequest generates a "aws/request.Request" representing the client's request for the UpdateHost 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 UpdateHost for more information on using the UpdateHost 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 UpdateHostRequest method.
req, resp := client.UpdateHostRequest(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/UpdateHost

func (*CodeStarConnections) UpdateHostWithContext 

func (c *CodeStarConnections) UpdateHostWithContext(ctx aws.Context, input *UpdateHostInput, opts ...request.Option) (*UpdateHostOutput, error)

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

See UpdateHost 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 ConflictException 

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

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

Two conflicting operations have been made on the same resource.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation

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 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.
	ProviderType *string `type:"string" enum:"ProviderType"`
	// 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) 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) SetHostArn 

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

SetHostArn sets the HostArn 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 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.
	ProviderType *string `type:"string" 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) SetHostArn 

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

SetHostArn sets the HostArn field's value.

func (*CreateConnectionInput) SetProviderType 

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

SetProviderType sets the ProviderType field's value.

func (*CreateConnectionInput) SetTags 

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 

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 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 *string `type:"string" required:"true" enum:"ProviderType"`

	Tags []*Tag `type:"list"`

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

func (s CreateHostInput) GoString() string

GoString returns the string representation

func (*CreateHostInput) SetName 

func (s *CreateHostInput) SetName(v string) *CreateHostInput

SetName sets the Name field's value.

func (*CreateHostInput) SetProviderEndpoint 

func (s *CreateHostInput) SetProviderEndpoint(v string) *CreateHostInput

SetProviderEndpoint sets the ProviderEndpoint field's value.

func (*CreateHostInput) SetProviderType 

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

SetProviderType sets the ProviderType field's value.

func (*CreateHostInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateHostInput) SetVpcConfiguration 

func (s *CreateHostInput) SetVpcConfiguration(v *VpcConfiguration) *CreateHostInput

SetVpcConfiguration sets the VpcConfiguration field's value.

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"`

	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateHostOutput) GoString 

func (s CreateHostOutput) GoString() string

GoString returns the string representation

func (*CreateHostOutput) SetHostArn 

func (s *CreateHostOutput) SetHostArn(v string) *CreateHostOutput

SetHostArn sets the HostArn field's value.

func (*CreateHostOutput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateHostOutput) String 

func (s CreateHostOutput) 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 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) GoString 

func (s DeleteHostInput) GoString() string

GoString returns the string representation

func (*DeleteHostInput) SetHostArn 

func (s *DeleteHostInput) SetHostArn(v string) *DeleteHostInput

SetHostArn sets the HostArn field's value.

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

func (s DeleteHostOutput) GoString() string

GoString returns the string representation

func (DeleteHostOutput) String 

func (s DeleteHostOutput) 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 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) GoString 

func (s GetHostInput) GoString() string

GoString returns the string representation

func (*GetHostInput) SetHostArn 

func (s *GetHostInput) SetHostArn(v string) *GetHostInput

SetHostArn sets the HostArn field's value.

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

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

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

func (GetHostOutput) GoString 

func (s GetHostOutput) GoString() string

GoString returns the string representation

func (*GetHostOutput) SetName 

func (s *GetHostOutput) SetName(v string) *GetHostOutput

SetName sets the Name field's value.

func (*GetHostOutput) SetProviderEndpoint 

func (s *GetHostOutput) SetProviderEndpoint(v string) *GetHostOutput

SetProviderEndpoint sets the ProviderEndpoint field's value.

func (*GetHostOutput) SetProviderType 

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

SetProviderType sets the ProviderType field's value.

func (*GetHostOutput) SetStatus 

func (s *GetHostOutput) SetStatus(v string) *GetHostOutput

SetStatus sets the Status field's value.

func (*GetHostOutput) SetVpcConfiguration 

func (s *GetHostOutput) SetVpcConfiguration(v *VpcConfiguration) *GetHostOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GetHostOutput) String 

func (s GetHostOutput) String() string

String returns the string representation

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

	// The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING,
	// VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
	Status *string `min:"1" 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) GoString 

func (s Host) GoString() string

GoString returns the string representation

func (*Host) SetHostArn 

func (s *Host) SetHostArn(v string) *Host

SetHostArn sets the HostArn field's value.

func (*Host) SetName 

func (s *Host) SetName(v string) *Host

SetName sets the Name field's value.

func (*Host) SetProviderEndpoint 

func (s *Host) SetProviderEndpoint(v string) *Host

SetProviderEndpoint sets the ProviderEndpoint field's value.

func (*Host) SetProviderType 

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

SetProviderType sets the ProviderType field's value.

func (*Host) SetStatus 

func (s *Host) SetStatus(v string) *Host

SetStatus sets the Status field's value.

func (*Host) SetStatusMessage 

func (s *Host) SetStatusMessage(v string) *Host

SetStatusMessage sets the StatusMessage field's value.

func (*Host) SetVpcConfiguration 

func (s *Host) SetVpcConfiguration(v *VpcConfiguration) *Host

SetVpcConfiguration sets the VpcConfiguration field's value.

func (Host) String 

func (s Host) String() string

String returns the string representation

type LimitExceededException 

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 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String 

func (s LimitExceededException) 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 *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) SetHostArnFilter 

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

SetHostArnFilter sets the HostArnFilter field's value.

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

func (s ListHostsInput) GoString() string

GoString returns the string representation

func (*ListHostsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListHostsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

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

func (s ListHostsOutput) GoString() string

GoString returns the string representation

func (*ListHostsOutput) SetHosts 

func (s *ListHostsOutput) SetHosts(v []*Host) *ListHostsOutput

SetHosts sets the Hosts field's value.

func (*ListHostsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListHostsOutput) String 

func (s ListHostsOutput) String() string

String returns the string representation

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

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ResourceNotFoundException 

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 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceUnavailableException 

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

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

Resource not found. Verify the ARN for the host resource and try again.

func (*ResourceUnavailableException) Code 

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error 

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString 

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation

func (*ResourceUnavailableException) Message 

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr 

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID 

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode 

func (s *ResourceUnavailableException) StatusCode() int

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

func (ResourceUnavailableException) String 

func (s ResourceUnavailableException) String() string

String returns the string representation

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

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey 

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

SetKey sets the Key field's value.

func (*Tag) SetValue 

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

SetValue sets the Value field's value.

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

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

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

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type UnsupportedOperationException 

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

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

The operation is not supported. Check the connection status and try again.

func (*UnsupportedOperationException) Code 

func (s *UnsupportedOperationException) Code() string

Code returns the exception type name.

func (*UnsupportedOperationException) Error 

func (s *UnsupportedOperationException) Error() string

func (UnsupportedOperationException) GoString 

func (s UnsupportedOperationException) GoString() string

GoString returns the string representation

func (*UnsupportedOperationException) Message 

func (s *UnsupportedOperationException) Message() string

Message returns the exception's message.

func (*UnsupportedOperationException) OrigErr 

func (s *UnsupportedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperationException) RequestID 

func (s *UnsupportedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperationException) StatusCode 

func (s *UnsupportedOperationException) StatusCode() int

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

func (UnsupportedOperationException) String 

func (s UnsupportedOperationException) String() string

String returns the string representation

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

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

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

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateHostInput 

type UpdateHostInput struct {

	// The Amazon Resource Name (ARN) of the host to be updated.
	//
	// HostArn is a required field
	HostArn *string `type:"string" required:"true"`

	// The URL or endpoint of the host to be updated.
	ProviderEndpoint *string `min:"1" type:"string"`

	// The VPC configuration of the host to be updated. 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 (UpdateHostInput) GoString 

func (s UpdateHostInput) GoString() string

GoString returns the string representation

func (*UpdateHostInput) SetHostArn 

func (s *UpdateHostInput) SetHostArn(v string) *UpdateHostInput

SetHostArn sets the HostArn field's value.

func (*UpdateHostInput) SetProviderEndpoint 

func (s *UpdateHostInput) SetProviderEndpoint(v string) *UpdateHostInput

SetProviderEndpoint sets the ProviderEndpoint field's value.

func (*UpdateHostInput) SetVpcConfiguration 

func (s *UpdateHostInput) SetVpcConfiguration(v *VpcConfiguration) *UpdateHostInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (UpdateHostInput) String 

func (s UpdateHostInput) String() string

String returns the string representation

func (*UpdateHostInput) Validate 

func (s *UpdateHostInput) Validate() error

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

type UpdateHostOutput 

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

func (UpdateHostOutput) GoString 

func (s UpdateHostOutput) GoString() string

GoString returns the string representation

func (UpdateHostOutput) String 

func (s UpdateHostOutput) String() string

String returns the string representation

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 `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The VPC configuration provisioned for the host.

func (VpcConfiguration) GoString 

func (s VpcConfiguration) GoString() string

GoString returns the string representation

func (*VpcConfiguration) SetSecurityGroupIds 

func (s *VpcConfiguration) SetSecurityGroupIds(v []*string) *VpcConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfiguration) SetSubnetIds 

func (s *VpcConfiguration) SetSubnetIds(v []*string) *VpcConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (*VpcConfiguration) SetTlsCertificate 

func (s *VpcConfiguration) SetTlsCertificate(v string) *VpcConfiguration

SetTlsCertificate sets the TlsCertificate field's value.

func (*VpcConfiguration) SetVpcId 

func (s *VpcConfiguration) SetVpcId(v string) *VpcConfiguration

SetVpcId sets the VpcId field's value.

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

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.