cloud9

package
v1.12.54 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2017 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package cloud9 provides the client and types for making API requests to AWS Cloud9.

AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

In the background, these tools are available through development environments running on Amazon Elastic Compute Cloud (Amazon EC2) instances (known as Amazon EC2 environments), your own servers (known as SSH environments), or a combination. This enables you to create and switch between multiple environments, with each environment set up for a specific development project.

For more information about AWS Cloud9, see the AWS Cloud9 User Guide.

AWS Cloud9 supports these operations:

  • CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then hosts the environment on the instance.

  • CreateEnvironmentMembership: Adds an environment member to an environment.

  • DeleteEnvironment: Deletes an environment. If the environment is hosted on an Amazon EC2 instance, also terminates the instance.

  • DeleteEnvironmentMembership: Deletes an environment member from an environment.

  • DescribeEnvironmentMemberships: Gets information about environment members for an environment.

  • DescribeEnvironments: Gets information about environments.

  • DescribeEnvironmentStatus: Gets status information for an environment.

  • ListEnvironments: Gets a list of environment identifiers.

  • UpdateEnvironment: Changes the settings of an existing environment.

  • UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

See https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// EnvironmentStatusError is a EnvironmentStatus enum value
	EnvironmentStatusError = "error"

	// EnvironmentStatusCreating is a EnvironmentStatus enum value
	EnvironmentStatusCreating = "creating"

	// EnvironmentStatusConnecting is a EnvironmentStatus enum value
	EnvironmentStatusConnecting = "connecting"

	// EnvironmentStatusReady is a EnvironmentStatus enum value
	EnvironmentStatusReady = "ready"

	// EnvironmentStatusStopping is a EnvironmentStatus enum value
	EnvironmentStatusStopping = "stopping"

	// EnvironmentStatusStopped is a EnvironmentStatus enum value
	EnvironmentStatusStopped = "stopped"

	// EnvironmentStatusDeleting is a EnvironmentStatus enum value
	EnvironmentStatusDeleting = "deleting"
)
View Source 
const (
	// EnvironmentTypeSsh is a EnvironmentType enum value
	EnvironmentTypeSsh = "ssh"

	// EnvironmentTypeEc2 is a EnvironmentType enum value
	EnvironmentTypeEc2 = "ec2"
)
View Source 
const (
	// MemberPermissionsReadWrite is a MemberPermissions enum value
	MemberPermissionsReadWrite = "read-write"

	// MemberPermissionsReadOnly is a MemberPermissions enum value
	MemberPermissionsReadOnly = "read-only"
)
View Source 
const (
	// PermissionsOwner is a Permissions enum value
	PermissionsOwner = "owner"

	// PermissionsReadWrite is a Permissions enum value
	PermissionsReadWrite = "read-write"

	// PermissionsReadOnly is a Permissions enum value
	PermissionsReadOnly = "read-only"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The target request is invalid.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A conflict occurred.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// An access permissions issue occurred.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// An internal server error occurred.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A service limit was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The target resource cannot be found.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Too many service requests were made over the given time period.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "cloud9"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Cloud9 

type Cloud9 struct {
	*client.Client
}

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

Cloud9 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) *Cloud9

New creates a new instance of the Cloud9 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: 

// Create a Cloud9 client from just a session.
svc := cloud9.New(mySession)

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

func (*Cloud9) CreateEnvironmentEC2 

func (c *Cloud9) CreateEnvironmentEC2(input *CreateEnvironmentEC2Input) (*CreateEnvironmentEC2Output, error)

CreateEnvironmentEC2 API operation for AWS Cloud9.

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then hosts the environment on the instance.

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 Cloud9's API operation CreateEnvironmentEC2 for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2

func (*Cloud9) CreateEnvironmentEC2Request 

func (c *Cloud9) CreateEnvironmentEC2Request(input *CreateEnvironmentEC2Input) (req *request.Request, output *CreateEnvironmentEC2Output)

CreateEnvironmentEC2Request generates a "aws/request.Request" representing the client's request for the CreateEnvironmentEC2 operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 CreateEnvironmentEC2 for more information on using the CreateEnvironmentEC2 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 CreateEnvironmentEC2Request method.
req, resp := client.CreateEnvironmentEC2Request(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2

func (*Cloud9) CreateEnvironmentEC2WithContext 

func (c *Cloud9) CreateEnvironmentEC2WithContext(ctx aws.Context, input *CreateEnvironmentEC2Input, opts ...request.Option) (*CreateEnvironmentEC2Output, error)

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

See CreateEnvironmentEC2 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 (*Cloud9) CreateEnvironmentMembership 

func (c *Cloud9) CreateEnvironmentMembership(input *CreateEnvironmentMembershipInput) (*CreateEnvironmentMembershipOutput, error)

CreateEnvironmentMembership API operation for AWS Cloud9.

Adds an environment member to an AWS Cloud9 development environment.

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 Cloud9's API operation CreateEnvironmentMembership for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembership

func (*Cloud9) CreateEnvironmentMembershipRequest 

func (c *Cloud9) CreateEnvironmentMembershipRequest(input *CreateEnvironmentMembershipInput) (req *request.Request, output *CreateEnvironmentMembershipOutput)

CreateEnvironmentMembershipRequest generates a "aws/request.Request" representing the client's request for the CreateEnvironmentMembership operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 CreateEnvironmentMembership for more information on using the CreateEnvironmentMembership 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 CreateEnvironmentMembershipRequest method.
req, resp := client.CreateEnvironmentMembershipRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembership

func (*Cloud9) CreateEnvironmentMembershipWithContext 

func (c *Cloud9) CreateEnvironmentMembershipWithContext(ctx aws.Context, input *CreateEnvironmentMembershipInput, opts ...request.Option) (*CreateEnvironmentMembershipOutput, error)

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

See CreateEnvironmentMembership 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 (*Cloud9) DeleteEnvironment 

func (c *Cloud9) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error)

DeleteEnvironment API operation for AWS Cloud9.

Deletes an AWS Cloud9 development environment. If the environment is hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also terminates the instance.

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 Cloud9's API operation DeleteEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironment

func (*Cloud9) DeleteEnvironmentMembership 

func (c *Cloud9) DeleteEnvironmentMembership(input *DeleteEnvironmentMembershipInput) (*DeleteEnvironmentMembershipOutput, error)

DeleteEnvironmentMembership API operation for AWS Cloud9.

Deletes an environment member from an AWS Cloud9 development environment.

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 Cloud9's API operation DeleteEnvironmentMembership for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembership

func (*Cloud9) DeleteEnvironmentMembershipRequest 

func (c *Cloud9) DeleteEnvironmentMembershipRequest(input *DeleteEnvironmentMembershipInput) (req *request.Request, output *DeleteEnvironmentMembershipOutput)

DeleteEnvironmentMembershipRequest generates a "aws/request.Request" representing the client's request for the DeleteEnvironmentMembership operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DeleteEnvironmentMembership for more information on using the DeleteEnvironmentMembership 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 DeleteEnvironmentMembershipRequest method.
req, resp := client.DeleteEnvironmentMembershipRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembership

func (*Cloud9) DeleteEnvironmentMembershipWithContext 

func (c *Cloud9) DeleteEnvironmentMembershipWithContext(ctx aws.Context, input *DeleteEnvironmentMembershipInput, opts ...request.Option) (*DeleteEnvironmentMembershipOutput, error)

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

See DeleteEnvironmentMembership 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 (*Cloud9) DeleteEnvironmentRequest 

func (c *Cloud9) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *request.Request, output *DeleteEnvironmentOutput)

DeleteEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteEnvironment operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DeleteEnvironment for more information on using the DeleteEnvironment 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 DeleteEnvironmentRequest method.
req, resp := client.DeleteEnvironmentRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironment

func (*Cloud9) DeleteEnvironmentWithContext 

func (c *Cloud9) DeleteEnvironmentWithContext(ctx aws.Context, input *DeleteEnvironmentInput, opts ...request.Option) (*DeleteEnvironmentOutput, error)

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

See DeleteEnvironment 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 (*Cloud9) DescribeEnvironmentMemberships 

func (c *Cloud9) DescribeEnvironmentMemberships(input *DescribeEnvironmentMembershipsInput) (*DescribeEnvironmentMembershipsOutput, error)

DescribeEnvironmentMemberships API operation for AWS Cloud9.

Gets information about environment members for an AWS Cloud9 development environment.

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 Cloud9's API operation DescribeEnvironmentMemberships for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMemberships

func (*Cloud9) DescribeEnvironmentMembershipsPages 

func (c *Cloud9) DescribeEnvironmentMembershipsPages(input *DescribeEnvironmentMembershipsInput, fn func(*DescribeEnvironmentMembershipsOutput, bool) bool) error

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

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

func (*Cloud9) DescribeEnvironmentMembershipsPagesWithContext 

func (c *Cloud9) DescribeEnvironmentMembershipsPagesWithContext(ctx aws.Context, input *DescribeEnvironmentMembershipsInput, fn func(*DescribeEnvironmentMembershipsOutput, bool) bool, opts ...request.Option) error

DescribeEnvironmentMembershipsPagesWithContext same as DescribeEnvironmentMembershipsPages 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 (*Cloud9) DescribeEnvironmentMembershipsRequest 

func (c *Cloud9) DescribeEnvironmentMembershipsRequest(input *DescribeEnvironmentMembershipsInput) (req *request.Request, output *DescribeEnvironmentMembershipsOutput)

DescribeEnvironmentMembershipsRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentMemberships operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DescribeEnvironmentMemberships for more information on using the DescribeEnvironmentMemberships 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 DescribeEnvironmentMembershipsRequest method.
req, resp := client.DescribeEnvironmentMembershipsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMemberships

func (*Cloud9) DescribeEnvironmentMembershipsWithContext 

func (c *Cloud9) DescribeEnvironmentMembershipsWithContext(ctx aws.Context, input *DescribeEnvironmentMembershipsInput, opts ...request.Option) (*DescribeEnvironmentMembershipsOutput, error)

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

See DescribeEnvironmentMemberships 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 (*Cloud9) DescribeEnvironmentStatus 

func (c *Cloud9) DescribeEnvironmentStatus(input *DescribeEnvironmentStatusInput) (*DescribeEnvironmentStatusOutput, error)

DescribeEnvironmentStatus API operation for AWS Cloud9.

Gets status information for an AWS Cloud9 development environment.

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 Cloud9's API operation DescribeEnvironmentStatus for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatus

func (*Cloud9) DescribeEnvironmentStatusRequest 

func (c *Cloud9) DescribeEnvironmentStatusRequest(input *DescribeEnvironmentStatusInput) (req *request.Request, output *DescribeEnvironmentStatusOutput)

DescribeEnvironmentStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironmentStatus operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DescribeEnvironmentStatus for more information on using the DescribeEnvironmentStatus 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 DescribeEnvironmentStatusRequest method.
req, resp := client.DescribeEnvironmentStatusRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatus

func (*Cloud9) DescribeEnvironmentStatusWithContext 

func (c *Cloud9) DescribeEnvironmentStatusWithContext(ctx aws.Context, input *DescribeEnvironmentStatusInput, opts ...request.Option) (*DescribeEnvironmentStatusOutput, error)

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

See DescribeEnvironmentStatus 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 (*Cloud9) DescribeEnvironments 

func (c *Cloud9) DescribeEnvironments(input *DescribeEnvironmentsInput) (*DescribeEnvironmentsOutput, error)

DescribeEnvironments API operation for AWS Cloud9.

Gets information about AWS Cloud9 development environments.

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 Cloud9's API operation DescribeEnvironments for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironments

func (*Cloud9) DescribeEnvironmentsRequest 

func (c *Cloud9) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) (req *request.Request, output *DescribeEnvironmentsOutput)

DescribeEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the DescribeEnvironments operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DescribeEnvironments for more information on using the DescribeEnvironments 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 DescribeEnvironmentsRequest method.
req, resp := client.DescribeEnvironmentsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironments

func (*Cloud9) DescribeEnvironmentsWithContext 

func (c *Cloud9) DescribeEnvironmentsWithContext(ctx aws.Context, input *DescribeEnvironmentsInput, opts ...request.Option) (*DescribeEnvironmentsOutput, error)

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

See DescribeEnvironments 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 (*Cloud9) ListEnvironments 

func (c *Cloud9) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error)

ListEnvironments API operation for AWS Cloud9.

Gets a list of AWS Cloud9 development environment identifiers.

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 Cloud9's API operation ListEnvironments for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironments

func (*Cloud9) ListEnvironmentsPages 

func (c *Cloud9) ListEnvironmentsPages(input *ListEnvironmentsInput, fn func(*ListEnvironmentsOutput, bool) bool) error

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

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

func (*Cloud9) ListEnvironmentsPagesWithContext 

func (c *Cloud9) ListEnvironmentsPagesWithContext(ctx aws.Context, input *ListEnvironmentsInput, fn func(*ListEnvironmentsOutput, bool) bool, opts ...request.Option) error

ListEnvironmentsPagesWithContext same as ListEnvironmentsPages 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 (*Cloud9) ListEnvironmentsRequest 

func (c *Cloud9) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *request.Request, output *ListEnvironmentsOutput)

ListEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ListEnvironments operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 ListEnvironments for more information on using the ListEnvironments 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 ListEnvironmentsRequest method.
req, resp := client.ListEnvironmentsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironments

func (*Cloud9) ListEnvironmentsWithContext 

func (c *Cloud9) ListEnvironmentsWithContext(ctx aws.Context, input *ListEnvironmentsInput, opts ...request.Option) (*ListEnvironmentsOutput, error)

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

See ListEnvironments 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 (*Cloud9) UpdateEnvironment 

func (c *Cloud9) UpdateEnvironment(input *UpdateEnvironmentInput) (*UpdateEnvironmentOutput, error)

UpdateEnvironment API operation for AWS Cloud9.

Changes the settings of an existing AWS Cloud9 development environment.

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 Cloud9's API operation UpdateEnvironment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironment

func (*Cloud9) UpdateEnvironmentMembership 

func (c *Cloud9) UpdateEnvironmentMembership(input *UpdateEnvironmentMembershipInput) (*UpdateEnvironmentMembershipOutput, error)

UpdateEnvironmentMembership API operation for AWS Cloud9.

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

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 Cloud9's API operation UpdateEnvironmentMembership for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" The target request is invalid.

  • ErrCodeConflictException "ConflictException" A conflict occurred.

  • ErrCodeNotFoundException "NotFoundException" The target resource cannot be found.

  • ErrCodeForbiddenException "ForbiddenException" An access permissions issue occurred.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Too many service requests were made over the given time period.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit was exceeded.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembership

func (*Cloud9) UpdateEnvironmentMembershipRequest 

func (c *Cloud9) UpdateEnvironmentMembershipRequest(input *UpdateEnvironmentMembershipInput) (req *request.Request, output *UpdateEnvironmentMembershipOutput)

UpdateEnvironmentMembershipRequest generates a "aws/request.Request" representing the client's request for the UpdateEnvironmentMembership operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 UpdateEnvironmentMembership for more information on using the UpdateEnvironmentMembership 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 UpdateEnvironmentMembershipRequest method.
req, resp := client.UpdateEnvironmentMembershipRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembership

func (*Cloud9) UpdateEnvironmentMembershipWithContext 

func (c *Cloud9) UpdateEnvironmentMembershipWithContext(ctx aws.Context, input *UpdateEnvironmentMembershipInput, opts ...request.Option) (*UpdateEnvironmentMembershipOutput, error)

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

See UpdateEnvironmentMembership 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 (*Cloud9) UpdateEnvironmentRequest 

func (c *Cloud9) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *request.Request, output *UpdateEnvironmentOutput)

UpdateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateEnvironment operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 UpdateEnvironment for more information on using the UpdateEnvironment 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 UpdateEnvironmentRequest method.
req, resp := client.UpdateEnvironmentRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironment

func (*Cloud9) UpdateEnvironmentWithContext 

func (c *Cloud9) UpdateEnvironmentWithContext(ctx aws.Context, input *UpdateEnvironmentInput, opts ...request.Option) (*UpdateEnvironmentOutput, error)

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

See UpdateEnvironment 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 CreateEnvironmentEC2Input 

type CreateEnvironmentEC2Input struct {

	// The number of minutes until the running instance is shut down after the environment
	// has last been used.
	AutomaticStopTimeMinutes *int64 `locationName:"automaticStopTimeMinutes" type:"integer"`

	// A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation
	// completes no more than one time.
	//
	// For more information, see Client Tokens (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html)
	// in the Amazon EC2 API Reference.
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string"`

	// The description of the environment to create.
	Description *string `locationName:"description" type:"string"`

	// The type of instance to host the environment on (for example, t2.micro).
	//
	// InstanceType is a required field
	InstanceType *string `locationName:"instanceType" min:"5" type:"string" required:"true"`

	// The name of the environment to create.
	//
	// This name is visible to other AWS IAM users in the same AWS account.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the environment owner. This ARN can be
	// the ARN of any AWS IAM principal. If this value is not specified, the ARN
	// defaults to this environment's creator.
	OwnerArn *string `locationName:"ownerArn" type:"string"`

	// The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate
	// with the Amazon EC2 instance.
	SubnetId *string `locationName:"subnetId" min:"5" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2Request

func (CreateEnvironmentEC2Input) GoString 

func (s CreateEnvironmentEC2Input) GoString() string

GoString returns the string representation

func (*CreateEnvironmentEC2Input) SetAutomaticStopTimeMinutes 

func (s *CreateEnvironmentEC2Input) SetAutomaticStopTimeMinutes(v int64) *CreateEnvironmentEC2Input

SetAutomaticStopTimeMinutes sets the AutomaticStopTimeMinutes field's value.

func (*CreateEnvironmentEC2Input) SetClientRequestToken 

func (s *CreateEnvironmentEC2Input) SetClientRequestToken(v string) *CreateEnvironmentEC2Input

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEnvironmentEC2Input) SetDescription 

func (s *CreateEnvironmentEC2Input) SetDescription(v string) *CreateEnvironmentEC2Input

SetDescription sets the Description field's value.

func (*CreateEnvironmentEC2Input) SetInstanceType 

func (s *CreateEnvironmentEC2Input) SetInstanceType(v string) *CreateEnvironmentEC2Input

SetInstanceType sets the InstanceType field's value.

func (*CreateEnvironmentEC2Input) SetName 

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

SetName sets the Name field's value.

func (*CreateEnvironmentEC2Input) SetOwnerArn 

func (s *CreateEnvironmentEC2Input) SetOwnerArn(v string) *CreateEnvironmentEC2Input

SetOwnerArn sets the OwnerArn field's value.

func (*CreateEnvironmentEC2Input) SetSubnetId 

func (s *CreateEnvironmentEC2Input) SetSubnetId(v string) *CreateEnvironmentEC2Input

SetSubnetId sets the SubnetId field's value.

func (CreateEnvironmentEC2Input) String 

func (s CreateEnvironmentEC2Input) String() string

String returns the string representation

func (*CreateEnvironmentEC2Input) Validate 

func (s *CreateEnvironmentEC2Input) Validate() error

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

type CreateEnvironmentEC2Output 

type CreateEnvironmentEC2Output struct {

	// The ID of the environment that was created.
	EnvironmentId *string `locationName:"environmentId" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2Result

func (CreateEnvironmentEC2Output) GoString 

func (s CreateEnvironmentEC2Output) GoString() string

GoString returns the string representation

func (*CreateEnvironmentEC2Output) SetEnvironmentId 

func (s *CreateEnvironmentEC2Output) SetEnvironmentId(v string) *CreateEnvironmentEC2Output

SetEnvironmentId sets the EnvironmentId field's value.

func (CreateEnvironmentEC2Output) String 

func (s CreateEnvironmentEC2Output) String() string

String returns the string representation

type CreateEnvironmentMembershipInput 

type CreateEnvironmentMembershipInput struct {

	// The ID of the environment that contains the environment member you want to
	// add.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`

	// The type of environment member permissions you want to associate with this
	// environment member. Available values include:
	//
	//    * read-only: Has read-only access to the environment.
	//
	//    * read-write: Has read-write access to the environment.
	//
	// Permissions is a required field
	Permissions *string `locationName:"permissions" type:"string" required:"true" enum:"MemberPermissions"`

	// The Amazon Resource Name (ARN) of the environment member you want to add.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembershipRequest

func (CreateEnvironmentMembershipInput) GoString 

func (s CreateEnvironmentMembershipInput) GoString() string

GoString returns the string representation

func (*CreateEnvironmentMembershipInput) SetEnvironmentId 

func (s *CreateEnvironmentMembershipInput) SetEnvironmentId(v string) *CreateEnvironmentMembershipInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateEnvironmentMembershipInput) SetPermissions 

func (s *CreateEnvironmentMembershipInput) SetPermissions(v string) *CreateEnvironmentMembershipInput

SetPermissions sets the Permissions field's value.

func (*CreateEnvironmentMembershipInput) SetUserArn 

func (s *CreateEnvironmentMembershipInput) SetUserArn(v string) *CreateEnvironmentMembershipInput

SetUserArn sets the UserArn field's value.

func (CreateEnvironmentMembershipInput) String 

func (s CreateEnvironmentMembershipInput) String() string

String returns the string representation

func (*CreateEnvironmentMembershipInput) Validate 

func (s *CreateEnvironmentMembershipInput) Validate() error

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

type CreateEnvironmentMembershipOutput 

type CreateEnvironmentMembershipOutput struct {

	// Information about the environment member that was added.
	Membership *EnvironmentMember `locationName:"membership" type:"structure"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembershipResult

func (CreateEnvironmentMembershipOutput) GoString 

func (s CreateEnvironmentMembershipOutput) GoString() string

GoString returns the string representation

func (*CreateEnvironmentMembershipOutput) SetMembership 

func (s *CreateEnvironmentMembershipOutput) SetMembership(v *EnvironmentMember) *CreateEnvironmentMembershipOutput

SetMembership sets the Membership field's value.

func (CreateEnvironmentMembershipOutput) String 

func (s CreateEnvironmentMembershipOutput) String() string

String returns the string representation

type DeleteEnvironmentInput 

type DeleteEnvironmentInput struct {

	// The ID of the environment to delete.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentRequest

func (DeleteEnvironmentInput) GoString 

func (s DeleteEnvironmentInput) GoString() string

GoString returns the string representation

func (*DeleteEnvironmentInput) SetEnvironmentId 

func (s *DeleteEnvironmentInput) SetEnvironmentId(v string) *DeleteEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DeleteEnvironmentInput) String 

func (s DeleteEnvironmentInput) String() string

String returns the string representation

func (*DeleteEnvironmentInput) Validate 

func (s *DeleteEnvironmentInput) Validate() error

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

type DeleteEnvironmentMembershipInput 

type DeleteEnvironmentMembershipInput struct {

	// The ID of the environment to delete the environment member from.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the environment member to delete from the
	// environment.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembershipRequest

func (DeleteEnvironmentMembershipInput) GoString 

func (s DeleteEnvironmentMembershipInput) GoString() string

GoString returns the string representation

func (*DeleteEnvironmentMembershipInput) SetEnvironmentId 

func (s *DeleteEnvironmentMembershipInput) SetEnvironmentId(v string) *DeleteEnvironmentMembershipInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*DeleteEnvironmentMembershipInput) SetUserArn 

func (s *DeleteEnvironmentMembershipInput) SetUserArn(v string) *DeleteEnvironmentMembershipInput

SetUserArn sets the UserArn field's value.

func (DeleteEnvironmentMembershipInput) String 

func (s DeleteEnvironmentMembershipInput) String() string

String returns the string representation

func (*DeleteEnvironmentMembershipInput) Validate 

func (s *DeleteEnvironmentMembershipInput) Validate() error

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

type DeleteEnvironmentMembershipOutput 

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembershipResult

func (DeleteEnvironmentMembershipOutput) GoString 

func (s DeleteEnvironmentMembershipOutput) GoString() string

GoString returns the string representation

func (DeleteEnvironmentMembershipOutput) String 

func (s DeleteEnvironmentMembershipOutput) String() string

String returns the string representation

type DeleteEnvironmentOutput 

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentResult

func (DeleteEnvironmentOutput) GoString 

func (s DeleteEnvironmentOutput) GoString() string

GoString returns the string representation

func (DeleteEnvironmentOutput) String 

func (s DeleteEnvironmentOutput) String() string

String returns the string representation

type DescribeEnvironmentMembershipsInput 

type DescribeEnvironmentMembershipsInput struct {

	// The ID of the environment to get environment member information about.
	EnvironmentId *string `locationName:"environmentId" type:"string"`

	// The maximum number of environment members to get information about.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// During a previous call, if there are more than 25 items in the list, only
	// the first 25 items are returned, along with a unique string called a next
	// token. To get the next batch of items in the list, call this operation again,
	// adding the next token to the call. To get all of the items in the list, keep
	// calling this operation with each subsequent next token that is returned,
	// until no more next tokens are returned.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of environment member permissions to get information about. Available
	// values include:
	//
	//    * owner: Owns the environment.
	//
	//    * read-only: Has read-only access to the environment.
	//
	//    * read-write: Has read-write access to the environment.
	//
	// If no value is specified, information about all environment members are returned.
	Permissions []*string `locationName:"permissions" type:"list"`

	// The Amazon Resource Name (ARN) of an individual environment member to get
	// information about. If no value is specified, information about all environment
	// members are returned.
	UserArn *string `locationName:"userArn" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMembershipsRequest

func (DescribeEnvironmentMembershipsInput) GoString 

func (s DescribeEnvironmentMembershipsInput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentMembershipsInput) SetEnvironmentId 

func (s *DescribeEnvironmentMembershipsInput) SetEnvironmentId(v string) *DescribeEnvironmentMembershipsInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*DescribeEnvironmentMembershipsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeEnvironmentMembershipsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeEnvironmentMembershipsInput) SetPermissions 

func (s *DescribeEnvironmentMembershipsInput) SetPermissions(v []*string) *DescribeEnvironmentMembershipsInput

SetPermissions sets the Permissions field's value.

func (*DescribeEnvironmentMembershipsInput) SetUserArn 

func (s *DescribeEnvironmentMembershipsInput) SetUserArn(v string) *DescribeEnvironmentMembershipsInput

SetUserArn sets the UserArn field's value.

func (DescribeEnvironmentMembershipsInput) String 

func (s DescribeEnvironmentMembershipsInput) String() string

String returns the string representation

type DescribeEnvironmentMembershipsOutput 

type DescribeEnvironmentMembershipsOutput struct {

	// Information about the environment members for the environment.
	Memberships []*EnvironmentMember `locationName:"memberships" type:"list"`

	// If there are more than 25 items in the list, only the first 25 items are
	// returned, along with a unique string called a next token. To get the next
	// batch of items in the list, call this operation again, adding the next token
	// to the call.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMembershipsResult

func (DescribeEnvironmentMembershipsOutput) GoString 

func (s DescribeEnvironmentMembershipsOutput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentMembershipsOutput) SetMemberships 

func (s *DescribeEnvironmentMembershipsOutput) SetMemberships(v []*EnvironmentMember) *DescribeEnvironmentMembershipsOutput

SetMemberships sets the Memberships field's value.

func (*DescribeEnvironmentMembershipsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (DescribeEnvironmentMembershipsOutput) String 

func (s DescribeEnvironmentMembershipsOutput) String() string

String returns the string representation

type DescribeEnvironmentStatusInput 

type DescribeEnvironmentStatusInput struct {

	// The ID of the environment to get status information about.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatusRequest

func (DescribeEnvironmentStatusInput) GoString 

func (s DescribeEnvironmentStatusInput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentStatusInput) SetEnvironmentId 

func (s *DescribeEnvironmentStatusInput) SetEnvironmentId(v string) *DescribeEnvironmentStatusInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DescribeEnvironmentStatusInput) String 

func (s DescribeEnvironmentStatusInput) String() string

String returns the string representation

func (*DescribeEnvironmentStatusInput) Validate 

func (s *DescribeEnvironmentStatusInput) Validate() error

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

type DescribeEnvironmentStatusOutput 

type DescribeEnvironmentStatusOutput struct {

	// Any informational message about the status of the environment.
	Message *string `locationName:"message" type:"string"`

	// The status of the environment. Available values include:
	//
	//    * connecting: The environment is connecting.
	//
	//    * creating: The environment is being created.
	//
	//    * deleting: The environment is being deleted.
	//
	//    * error: The environment is in an error state.
	//
	//    * ready: The environment is ready.
	//
	//    * stopped: The environment is stopped.
	//
	//    * stopping: The environment is stopping.
	Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatusResult

func (DescribeEnvironmentStatusOutput) GoString 

func (s DescribeEnvironmentStatusOutput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentStatusOutput) SetMessage 

func (s *DescribeEnvironmentStatusOutput) SetMessage(v string) *DescribeEnvironmentStatusOutput

SetMessage sets the Message field's value.

func (*DescribeEnvironmentStatusOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (DescribeEnvironmentStatusOutput) String 

func (s DescribeEnvironmentStatusOutput) String() string

String returns the string representation

type DescribeEnvironmentsInput 

type DescribeEnvironmentsInput struct {

	// The IDs of invidividual environments to get information about.
	//
	// EnvironmentIds is a required field
	EnvironmentIds []*string `locationName:"environmentIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentsRequest

func (DescribeEnvironmentsInput) GoString 

func (s DescribeEnvironmentsInput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentsInput) SetEnvironmentIds 

func (s *DescribeEnvironmentsInput) SetEnvironmentIds(v []*string) *DescribeEnvironmentsInput

SetEnvironmentIds sets the EnvironmentIds field's value.

func (DescribeEnvironmentsInput) String 

func (s DescribeEnvironmentsInput) String() string

String returns the string representation

func (*DescribeEnvironmentsInput) Validate 

func (s *DescribeEnvironmentsInput) Validate() error

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

type DescribeEnvironmentsOutput 

type DescribeEnvironmentsOutput struct {

	// Information about the environments that are returned.
	Environments []*Environment `locationName:"environments" type:"list"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentsResult

func (DescribeEnvironmentsOutput) GoString 

func (s DescribeEnvironmentsOutput) GoString() string

GoString returns the string representation

func (*DescribeEnvironmentsOutput) SetEnvironments 

func (s *DescribeEnvironmentsOutput) SetEnvironments(v []*Environment) *DescribeEnvironmentsOutput

SetEnvironments sets the Environments field's value.

func (DescribeEnvironmentsOutput) String 

func (s DescribeEnvironmentsOutput) String() string

String returns the string representation

type Environment 

type Environment struct {

	// The Amazon Resource Name (ARN) of the environment.
	Arn *string `locationName:"arn" type:"string"`

	// The description for the environment.
	Description *string `locationName:"description" type:"string"`

	// The ID of the environment.
	Id *string `locationName:"id" type:"string"`

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

	// The Amazon Resource Name (ARN) of the environment owner.
	OwnerArn *string `locationName:"ownerArn" type:"string"`

	// The type of environment. Valid values include the following:
	//
	//    * ec2: An environment hosted on an Amazon Elastic Compute Cloud (Amazon
	//    EC2) instance.
	//
	//    * ssh: An environment hosted on your own server.
	Type *string `locationName:"type" type:"string" enum:"EnvironmentType"`
	// contains filtered or unexported fields
}

Information about an AWS Cloud9 development environment. See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/Environment

func (Environment) GoString 

func (s Environment) GoString() string

GoString returns the string representation

func (*Environment) SetArn 

func (s *Environment) SetArn(v string) *Environment

SetArn sets the Arn field's value.

func (*Environment) SetDescription 

func (s *Environment) SetDescription(v string) *Environment

SetDescription sets the Description field's value.

func (*Environment) SetId 

func (s *Environment) SetId(v string) *Environment

SetId sets the Id field's value.

func (*Environment) SetName 

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

SetName sets the Name field's value.

func (*Environment) SetOwnerArn 

func (s *Environment) SetOwnerArn(v string) *Environment

SetOwnerArn sets the OwnerArn field's value.

func (*Environment) SetType 

func (s *Environment) SetType(v string) *Environment

SetType sets the Type field's value.

func (Environment) String 

func (s Environment) String() string

String returns the string representation

type EnvironmentMember 

type EnvironmentMember struct {

	// The ID of the environment for the environment member.
	EnvironmentId *string `locationName:"environmentId" type:"string"`

	// The time, expressed in epoch time format, when the environment member last
	// opened the environment.
	LastAccess *time.Time `locationName:"lastAccess" type:"timestamp" timestampFormat:"unix"`

	// The type of environment member permissions associated with this environment
	// member. Available values include:
	//
	//    * owner: Owns the environment.
	//
	//    * read-only: Has read-only access to the environment.
	//
	//    * read-write: Has read-write access to the environment.
	Permissions *string `locationName:"permissions" type:"string" enum:"Permissions"`

	// The Amazon Resource Name (ARN) of the environment member.
	UserArn *string `locationName:"userArn" type:"string"`

	// The user ID in AWS Identity and Access Management (AWS IAM) of the environment
	// member.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

Information about an environment member for an AWS Cloud9 development environment. See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/EnvironmentMember

func (EnvironmentMember) GoString 

func (s EnvironmentMember) GoString() string

GoString returns the string representation

func (*EnvironmentMember) SetEnvironmentId 

func (s *EnvironmentMember) SetEnvironmentId(v string) *EnvironmentMember

SetEnvironmentId sets the EnvironmentId field's value.

func (*EnvironmentMember) SetLastAccess 

func (s *EnvironmentMember) SetLastAccess(v time.Time) *EnvironmentMember

SetLastAccess sets the LastAccess field's value.

func (*EnvironmentMember) SetPermissions 

func (s *EnvironmentMember) SetPermissions(v string) *EnvironmentMember

SetPermissions sets the Permissions field's value.

func (*EnvironmentMember) SetUserArn 

func (s *EnvironmentMember) SetUserArn(v string) *EnvironmentMember

SetUserArn sets the UserArn field's value.

func (*EnvironmentMember) SetUserId 

func (s *EnvironmentMember) SetUserId(v string) *EnvironmentMember

SetUserId sets the UserId field's value.

func (EnvironmentMember) String 

func (s EnvironmentMember) String() string

String returns the string representation

type ListEnvironmentsInput 

type ListEnvironmentsInput struct {

	// The maximum number of environments to get identifiers for.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// During a previous call, if there are more than 25 items in the list, only
	// the first 25 items are returned, along with a unique string called a next
	// token. To get the next batch of items in the list, call this operation again,
	// adding the next token to the call. To get all of the items in the list, keep
	// calling this operation with each subsequent next token that is returned,
	// until no more next tokens are returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironmentsRequest

func (ListEnvironmentsInput) GoString 

func (s ListEnvironmentsInput) GoString() string

GoString returns the string representation

func (*ListEnvironmentsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListEnvironmentsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListEnvironmentsInput) String 

func (s ListEnvironmentsInput) String() string

String returns the string representation

type ListEnvironmentsOutput 

type ListEnvironmentsOutput struct {

	// The list of environment identifiers.
	EnvironmentIds []*string `locationName:"environmentIds" type:"list"`

	// If there are more than 25 items in the list, only the first 25 items are
	// returned, along with a unique string called a next token. To get the next
	// batch of items in the list, call this operation again, adding the next token
	// to the call.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironmentsResult

func (ListEnvironmentsOutput) GoString 

func (s ListEnvironmentsOutput) GoString() string

GoString returns the string representation

func (*ListEnvironmentsOutput) SetEnvironmentIds 

func (s *ListEnvironmentsOutput) SetEnvironmentIds(v []*string) *ListEnvironmentsOutput

SetEnvironmentIds sets the EnvironmentIds field's value.

func (*ListEnvironmentsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListEnvironmentsOutput) String 

func (s ListEnvironmentsOutput) String() string

String returns the string representation

type UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

	// Any new or replacement description for the environment.
	Description *string `locationName:"description" type:"string"`

	// The ID of the environment to change settings.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`

	// Any replacement name for the environment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentRequest

func (UpdateEnvironmentInput) GoString 

func (s UpdateEnvironmentInput) GoString() string

GoString returns the string representation

func (*UpdateEnvironmentInput) SetDescription 

func (s *UpdateEnvironmentInput) SetDescription(v string) *UpdateEnvironmentInput

SetDescription sets the Description field's value.

func (*UpdateEnvironmentInput) SetEnvironmentId 

func (s *UpdateEnvironmentInput) SetEnvironmentId(v string) *UpdateEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateEnvironmentInput) SetName 

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

SetName sets the Name field's value.

func (UpdateEnvironmentInput) String 

func (s UpdateEnvironmentInput) String() string

String returns the string representation

func (*UpdateEnvironmentInput) Validate 

func (s *UpdateEnvironmentInput) Validate() error

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

type UpdateEnvironmentMembershipInput 

type UpdateEnvironmentMembershipInput struct {

	// The ID of the environment for the environment member whose settings you want
	// to change.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `locationName:"environmentId" type:"string" required:"true"`

	// The replacement type of environment member permissions you want to associate
	// with this environment member. Available values include:
	//
	//    * read-only: Has read-only access to the environment.
	//
	//    * read-write: Has read-write access to the environment.
	//
	// Permissions is a required field
	Permissions *string `locationName:"permissions" type:"string" required:"true" enum:"MemberPermissions"`

	// The Amazon Resource Name (ARN) of the environment member whose settings you
	// want to change.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembershipRequest

func (UpdateEnvironmentMembershipInput) GoString 

func (s UpdateEnvironmentMembershipInput) GoString() string

GoString returns the string representation

func (*UpdateEnvironmentMembershipInput) SetEnvironmentId 

func (s *UpdateEnvironmentMembershipInput) SetEnvironmentId(v string) *UpdateEnvironmentMembershipInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateEnvironmentMembershipInput) SetPermissions 

func (s *UpdateEnvironmentMembershipInput) SetPermissions(v string) *UpdateEnvironmentMembershipInput

SetPermissions sets the Permissions field's value.

func (*UpdateEnvironmentMembershipInput) SetUserArn 

func (s *UpdateEnvironmentMembershipInput) SetUserArn(v string) *UpdateEnvironmentMembershipInput

SetUserArn sets the UserArn field's value.

func (UpdateEnvironmentMembershipInput) String 

func (s UpdateEnvironmentMembershipInput) String() string

String returns the string representation

func (*UpdateEnvironmentMembershipInput) Validate 

func (s *UpdateEnvironmentMembershipInput) Validate() error

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

type UpdateEnvironmentMembershipOutput 

type UpdateEnvironmentMembershipOutput struct {

	// Information about the environment member whose settings were changed.
	Membership *EnvironmentMember `locationName:"membership" type:"structure"`
	// contains filtered or unexported fields
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembershipResult

func (UpdateEnvironmentMembershipOutput) GoString 

func (s UpdateEnvironmentMembershipOutput) GoString() string

GoString returns the string representation

func (*UpdateEnvironmentMembershipOutput) SetMembership 

func (s *UpdateEnvironmentMembershipOutput) SetMembership(v *EnvironmentMember) *UpdateEnvironmentMembershipOutput

SetMembership sets the Membership field's value.

func (UpdateEnvironmentMembershipOutput) String 

func (s UpdateEnvironmentMembershipOutput) String() string

String returns the string representation

type UpdateEnvironmentOutput 

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentResult

func (UpdateEnvironmentOutput) GoString 

func (s UpdateEnvironmentOutput) GoString() string

GoString returns the string representation

func (UpdateEnvironmentOutput) String 

func (s UpdateEnvironmentOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package cloud9iface provides an interface to enable mocking the AWS Cloud9 service client for testing your code.
 Package cloud9iface provides an interface to enable mocking the AWS Cloud9 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.