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.
For more information about AWS Cloud9, see the AWS Cloud9 User Guide (https://docs.aws.amazon.com/cloud9/latest/user-guide).
AWS Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, 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 use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloud9/#New
Index ¶
- Constants
- type Client
- func (c *Client) CreateEnvironmentEC2Request(input *CreateEnvironmentEC2Input) CreateEnvironmentEC2Request
- func (c *Client) CreateEnvironmentMembershipRequest(input *CreateEnvironmentMembershipInput) CreateEnvironmentMembershipRequest
- func (c *Client) DeleteEnvironmentMembershipRequest(input *DeleteEnvironmentMembershipInput) DeleteEnvironmentMembershipRequest
- func (c *Client) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) DeleteEnvironmentRequest
- func (c *Client) DescribeEnvironmentMembershipsRequest(input *DescribeEnvironmentMembershipsInput) DescribeEnvironmentMembershipsRequest
- func (c *Client) DescribeEnvironmentStatusRequest(input *DescribeEnvironmentStatusInput) DescribeEnvironmentStatusRequest
- func (c *Client) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) DescribeEnvironmentsRequest
- func (c *Client) ListEnvironmentsRequest(input *ListEnvironmentsInput) ListEnvironmentsRequest
- func (c *Client) UpdateEnvironmentMembershipRequest(input *UpdateEnvironmentMembershipInput) UpdateEnvironmentMembershipRequest
- func (c *Client) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) UpdateEnvironmentRequest
- type CreateEnvironmentEC2Input
- type CreateEnvironmentEC2Output
- type CreateEnvironmentEC2Request
- type CreateEnvironmentEC2Response
- type CreateEnvironmentMembershipInput
- type CreateEnvironmentMembershipOutput
- type CreateEnvironmentMembershipRequest
- type CreateEnvironmentMembershipResponse
- type DeleteEnvironmentInput
- type DeleteEnvironmentMembershipInput
- type DeleteEnvironmentMembershipOutput
- type DeleteEnvironmentMembershipRequest
- type DeleteEnvironmentMembershipResponse
- type DeleteEnvironmentOutput
- type DeleteEnvironmentRequest
- type DeleteEnvironmentResponse
- type DescribeEnvironmentMembershipsInput
- type DescribeEnvironmentMembershipsOutput
- type DescribeEnvironmentMembershipsPaginator
- type DescribeEnvironmentMembershipsRequest
- type DescribeEnvironmentMembershipsResponse
- type DescribeEnvironmentStatusInput
- type DescribeEnvironmentStatusOutput
- type DescribeEnvironmentStatusRequest
- type DescribeEnvironmentStatusResponse
- type DescribeEnvironmentsInput
- type DescribeEnvironmentsOutput
- type DescribeEnvironmentsRequest
- type DescribeEnvironmentsResponse
- type Environment
- type EnvironmentLifecycle
- type EnvironmentLifecycleStatus
- type EnvironmentMember
- type EnvironmentStatus
- type EnvironmentType
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListEnvironmentsPaginator
- type ListEnvironmentsRequest
- type ListEnvironmentsResponse
- type MemberPermissions
- type Permissions
- type UpdateEnvironmentInput
- type UpdateEnvironmentMembershipInput
- type UpdateEnvironmentMembershipOutput
- type UpdateEnvironmentMembershipRequest
- type UpdateEnvironmentMembershipResponse
- type UpdateEnvironmentOutput
- type UpdateEnvironmentRequest
- type UpdateEnvironmentResponse
Examples ¶
- Client.CreateEnvironmentEC2Request (Shared00)
- Client.CreateEnvironmentMembershipRequest (Shared00)
- Client.DeleteEnvironmentMembershipRequest (Shared00)
- Client.DeleteEnvironmentRequest (Shared00)
- Client.DescribeEnvironmentMembershipsRequest (Shared00)
- Client.DescribeEnvironmentMembershipsRequest (Shared01)
- Client.DescribeEnvironmentMembershipsRequest (Shared02)
- Client.DescribeEnvironmentStatusRequest (Shared00)
- Client.DescribeEnvironmentsRequest (Shared00)
- Client.ListEnvironmentsRequest (Shared00)
- Client.UpdateEnvironmentMembershipRequest (Shared00)
- Client.UpdateEnvironmentRequest (Shared00)
Constants ¶
const ( ServiceName = "AWS Cloud9" // Service's name ServiceID = "Cloud9" // Service's identifier EndpointsID = "cloud9" // Service's Endpoint identifier )
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" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS Cloud9. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := cloud9.New(myConfig)
func (*Client) CreateEnvironmentEC2Request ¶ added in v0.9.0
func (c *Client) CreateEnvironmentEC2Request(input *CreateEnvironmentEC2Input) CreateEnvironmentEC2Request
CreateEnvironmentEC2Request returns a request value for making API operation for AWS Cloud9.
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
// Example sending a request using CreateEnvironmentEC2Request. req := client.CreateEnvironmentEC2Request(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2
func (*Client) CreateEnvironmentMembershipRequest ¶ added in v0.9.0
func (c *Client) CreateEnvironmentMembershipRequest(input *CreateEnvironmentMembershipInput) CreateEnvironmentMembershipRequest
CreateEnvironmentMembershipRequest returns a request value for making API operation for AWS Cloud9.
Adds an environment member to an AWS Cloud9 development environment.
// Example sending a request using CreateEnvironmentMembershipRequest. req := client.CreateEnvironmentMembershipRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembership
func (*Client) DeleteEnvironmentMembershipRequest ¶ added in v0.9.0
func (c *Client) DeleteEnvironmentMembershipRequest(input *DeleteEnvironmentMembershipInput) DeleteEnvironmentMembershipRequest
DeleteEnvironmentMembershipRequest returns a request value for making API operation for AWS Cloud9.
Deletes an environment member from an AWS Cloud9 development environment.
// Example sending a request using DeleteEnvironmentMembershipRequest. req := client.DeleteEnvironmentMembershipRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembership
func (*Client) DeleteEnvironmentRequest ¶ added in v0.9.0
func (c *Client) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) DeleteEnvironmentRequest
DeleteEnvironmentRequest returns a request value for making API operation for AWS Cloud9.
Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
// Example sending a request using DeleteEnvironmentRequest. req := client.DeleteEnvironmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironment
func (*Client) DescribeEnvironmentMembershipsRequest ¶ added in v0.9.0
func (c *Client) DescribeEnvironmentMembershipsRequest(input *DescribeEnvironmentMembershipsInput) DescribeEnvironmentMembershipsRequest
DescribeEnvironmentMembershipsRequest returns a request value for making API operation for AWS Cloud9.
Gets information about environment members for an AWS Cloud9 development environment.
// Example sending a request using DescribeEnvironmentMembershipsRequest. req := client.DescribeEnvironmentMembershipsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMemberships
func (*Client) DescribeEnvironmentStatusRequest ¶ added in v0.9.0
func (c *Client) DescribeEnvironmentStatusRequest(input *DescribeEnvironmentStatusInput) DescribeEnvironmentStatusRequest
DescribeEnvironmentStatusRequest returns a request value for making API operation for AWS Cloud9.
Gets status information for an AWS Cloud9 development environment.
// Example sending a request using DescribeEnvironmentStatusRequest. req := client.DescribeEnvironmentStatusRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatus
func (*Client) DescribeEnvironmentsRequest ¶ added in v0.9.0
func (c *Client) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) DescribeEnvironmentsRequest
DescribeEnvironmentsRequest returns a request value for making API operation for AWS Cloud9.
Gets information about AWS Cloud9 development environments.
// Example sending a request using DescribeEnvironmentsRequest. req := client.DescribeEnvironmentsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironments
func (*Client) ListEnvironmentsRequest ¶ added in v0.9.0
func (c *Client) ListEnvironmentsRequest(input *ListEnvironmentsInput) ListEnvironmentsRequest
ListEnvironmentsRequest returns a request value for making API operation for AWS Cloud9.
Gets a list of AWS Cloud9 development environment identifiers.
// Example sending a request using ListEnvironmentsRequest. req := client.ListEnvironmentsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironments
func (*Client) UpdateEnvironmentMembershipRequest ¶ added in v0.9.0
func (c *Client) UpdateEnvironmentMembershipRequest(input *UpdateEnvironmentMembershipInput) UpdateEnvironmentMembershipRequest
UpdateEnvironmentMembershipRequest returns a request value for making API operation for AWS Cloud9.
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
// Example sending a request using UpdateEnvironmentMembershipRequest. req := client.UpdateEnvironmentMembershipRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembership
func (*Client) UpdateEnvironmentRequest ¶ added in v0.9.0
func (c *Client) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) UpdateEnvironmentRequest
UpdateEnvironmentRequest returns a request value for making API operation for AWS Cloud9.
Changes the settings of an existing AWS Cloud9 development environment.
// Example sending a request using UpdateEnvironmentRequest. req := client.UpdateEnvironmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironment
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 connect to the environment (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 }
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 }
func (CreateEnvironmentEC2Output) String ¶
func (s CreateEnvironmentEC2Output) String() string
String returns the string representation
type CreateEnvironmentEC2Request ¶
type CreateEnvironmentEC2Request struct { *aws.Request Input *CreateEnvironmentEC2Input Copy func(*CreateEnvironmentEC2Input) CreateEnvironmentEC2Request }
CreateEnvironmentEC2Request is the request type for the CreateEnvironmentEC2 API operation.
func (CreateEnvironmentEC2Request) Send ¶
func (r CreateEnvironmentEC2Request) Send(ctx context.Context) (*CreateEnvironmentEC2Response, error)
Send marshals and sends the CreateEnvironmentEC2 API request.
type CreateEnvironmentEC2Response ¶ added in v0.9.0
type CreateEnvironmentEC2Response struct { *CreateEnvironmentEC2Output // contains filtered or unexported fields }
CreateEnvironmentEC2Response is the response type for the CreateEnvironmentEC2 API operation.
func (*CreateEnvironmentEC2Response) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateEnvironmentEC2Response) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateEnvironmentEC2 request.
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 MemberPermissions `locationName:"permissions" type:"string" required:"true" enum:"true"` // 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 }
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 }
func (CreateEnvironmentMembershipOutput) String ¶
func (s CreateEnvironmentMembershipOutput) String() string
String returns the string representation
type CreateEnvironmentMembershipRequest ¶
type CreateEnvironmentMembershipRequest struct { *aws.Request Input *CreateEnvironmentMembershipInput Copy func(*CreateEnvironmentMembershipInput) CreateEnvironmentMembershipRequest }
CreateEnvironmentMembershipRequest is the request type for the CreateEnvironmentMembership API operation.
func (CreateEnvironmentMembershipRequest) Send ¶
func (r CreateEnvironmentMembershipRequest) Send(ctx context.Context) (*CreateEnvironmentMembershipResponse, error)
Send marshals and sends the CreateEnvironmentMembership API request.
type CreateEnvironmentMembershipResponse ¶ added in v0.9.0
type CreateEnvironmentMembershipResponse struct { *CreateEnvironmentMembershipOutput // contains filtered or unexported fields }
CreateEnvironmentMembershipResponse is the response type for the CreateEnvironmentMembership API operation.
func (*CreateEnvironmentMembershipResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateEnvironmentMembershipResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateEnvironmentMembership request.
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 }
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 }
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
}
func (DeleteEnvironmentMembershipOutput) String ¶
func (s DeleteEnvironmentMembershipOutput) String() string
String returns the string representation
type DeleteEnvironmentMembershipRequest ¶
type DeleteEnvironmentMembershipRequest struct { *aws.Request Input *DeleteEnvironmentMembershipInput Copy func(*DeleteEnvironmentMembershipInput) DeleteEnvironmentMembershipRequest }
DeleteEnvironmentMembershipRequest is the request type for the DeleteEnvironmentMembership API operation.
func (DeleteEnvironmentMembershipRequest) Send ¶
func (r DeleteEnvironmentMembershipRequest) Send(ctx context.Context) (*DeleteEnvironmentMembershipResponse, error)
Send marshals and sends the DeleteEnvironmentMembership API request.
type DeleteEnvironmentMembershipResponse ¶ added in v0.9.0
type DeleteEnvironmentMembershipResponse struct { *DeleteEnvironmentMembershipOutput // contains filtered or unexported fields }
DeleteEnvironmentMembershipResponse is the response type for the DeleteEnvironmentMembership API operation.
func (*DeleteEnvironmentMembershipResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteEnvironmentMembershipResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteEnvironmentMembership request.
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (DeleteEnvironmentOutput) String ¶
func (s DeleteEnvironmentOutput) String() string
String returns the string representation
type DeleteEnvironmentRequest ¶
type DeleteEnvironmentRequest struct { *aws.Request Input *DeleteEnvironmentInput Copy func(*DeleteEnvironmentInput) DeleteEnvironmentRequest }
DeleteEnvironmentRequest is the request type for the DeleteEnvironment API operation.
func (DeleteEnvironmentRequest) Send ¶
func (r DeleteEnvironmentRequest) Send(ctx context.Context) (*DeleteEnvironmentResponse, error)
Send marshals and sends the DeleteEnvironment API request.
type DeleteEnvironmentResponse ¶ added in v0.9.0
type DeleteEnvironmentResponse struct { *DeleteEnvironmentOutput // contains filtered or unexported fields }
DeleteEnvironmentResponse is the response type for the DeleteEnvironment API operation.
func (*DeleteEnvironmentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteEnvironmentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteEnvironment request.
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 []Permissions `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 }
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 }
func (DescribeEnvironmentMembershipsOutput) String ¶
func (s DescribeEnvironmentMembershipsOutput) String() string
String returns the string representation
type DescribeEnvironmentMembershipsPaginator ¶ added in v0.9.0
DescribeEnvironmentMembershipsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeEnvironmentMembershipsPaginator ¶ added in v0.9.0
func NewDescribeEnvironmentMembershipsPaginator(req DescribeEnvironmentMembershipsRequest) DescribeEnvironmentMembershipsPaginator
NewDescribeEnvironmentMembershipsRequestPaginator returns a paginator for DescribeEnvironmentMemberships. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.DescribeEnvironmentMembershipsRequest(input) p := cloud9.NewDescribeEnvironmentMembershipsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeEnvironmentMembershipsPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeEnvironmentMembershipsPaginator) CurrentPage() *DescribeEnvironmentMembershipsOutput
type DescribeEnvironmentMembershipsRequest ¶
type DescribeEnvironmentMembershipsRequest struct { *aws.Request Input *DescribeEnvironmentMembershipsInput Copy func(*DescribeEnvironmentMembershipsInput) DescribeEnvironmentMembershipsRequest }
DescribeEnvironmentMembershipsRequest is the request type for the DescribeEnvironmentMemberships API operation.
func (DescribeEnvironmentMembershipsRequest) Send ¶
func (r DescribeEnvironmentMembershipsRequest) Send(ctx context.Context) (*DescribeEnvironmentMembershipsResponse, error)
Send marshals and sends the DescribeEnvironmentMemberships API request.
type DescribeEnvironmentMembershipsResponse ¶ added in v0.9.0
type DescribeEnvironmentMembershipsResponse struct { *DescribeEnvironmentMembershipsOutput // contains filtered or unexported fields }
DescribeEnvironmentMembershipsResponse is the response type for the DescribeEnvironmentMemberships API operation.
func (*DescribeEnvironmentMembershipsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeEnvironmentMembershipsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeEnvironmentMemberships request.
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 }
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 EnvironmentStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
func (DescribeEnvironmentStatusOutput) String ¶
func (s DescribeEnvironmentStatusOutput) String() string
String returns the string representation
type DescribeEnvironmentStatusRequest ¶
type DescribeEnvironmentStatusRequest struct { *aws.Request Input *DescribeEnvironmentStatusInput Copy func(*DescribeEnvironmentStatusInput) DescribeEnvironmentStatusRequest }
DescribeEnvironmentStatusRequest is the request type for the DescribeEnvironmentStatus API operation.
func (DescribeEnvironmentStatusRequest) Send ¶
func (r DescribeEnvironmentStatusRequest) Send(ctx context.Context) (*DescribeEnvironmentStatusResponse, error)
Send marshals and sends the DescribeEnvironmentStatus API request.
type DescribeEnvironmentStatusResponse ¶ added in v0.9.0
type DescribeEnvironmentStatusResponse struct { *DescribeEnvironmentStatusOutput // contains filtered or unexported fields }
DescribeEnvironmentStatusResponse is the response type for the DescribeEnvironmentStatus API operation.
func (*DescribeEnvironmentStatusResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeEnvironmentStatusResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeEnvironmentStatus request.
type DescribeEnvironmentsInput ¶
type DescribeEnvironmentsInput struct { // The IDs of individual 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 }
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 }
func (DescribeEnvironmentsOutput) String ¶
func (s DescribeEnvironmentsOutput) String() string
String returns the string representation
type DescribeEnvironmentsRequest ¶
type DescribeEnvironmentsRequest struct { *aws.Request Input *DescribeEnvironmentsInput Copy func(*DescribeEnvironmentsInput) DescribeEnvironmentsRequest }
DescribeEnvironmentsRequest is the request type for the DescribeEnvironments API operation.
func (DescribeEnvironmentsRequest) Send ¶
func (r DescribeEnvironmentsRequest) Send(ctx context.Context) (*DescribeEnvironmentsResponse, error)
Send marshals and sends the DescribeEnvironments API request.
type DescribeEnvironmentsResponse ¶ added in v0.9.0
type DescribeEnvironmentsResponse struct { *DescribeEnvironmentsOutput // contains filtered or unexported fields }
DescribeEnvironmentsResponse is the response type for the DescribeEnvironments API operation.
func (*DescribeEnvironmentsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeEnvironmentsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeEnvironments request.
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 state of the environment in its creation or deletion lifecycle. Lifecycle *EnvironmentLifecycle `locationName:"lifecycle" type:"structure"` // 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 Amazon Elastic Compute Cloud (Amazon EC2) instance connects // to the environment. // // * ssh: Your own server connects to the environment. Type EnvironmentType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Information about an AWS Cloud9 development environment.
func (Environment) String ¶
func (s Environment) String() string
String returns the string representation
type EnvironmentLifecycle ¶ added in v0.8.0
type EnvironmentLifecycle struct { // If the environment failed to delete, the Amazon Resource Name (ARN) of the // related AWS resource. FailureResource *string `locationName:"failureResource" type:"string"` // Any informational message about the lifecycle state of the environment. Reason *string `locationName:"reason" type:"string"` // The current creation or deletion lifecycle state of the environment. // // * CREATED: The environment was successfully created. // // * DELETE_FAILED: The environment failed to delete. // // * DELETING: The environment is in the process of being deleted. Status EnvironmentLifecycleStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.
func (EnvironmentLifecycle) String ¶ added in v0.8.0
func (s EnvironmentLifecycle) String() string
String returns the string representation
type EnvironmentLifecycleStatus ¶ added in v0.8.0
type EnvironmentLifecycleStatus string
const ( EnvironmentLifecycleStatusCreated EnvironmentLifecycleStatus = "CREATED" EnvironmentLifecycleStatusDeleting EnvironmentLifecycleStatus = "DELETING" EnvironmentLifecycleStatusDeleteFailed EnvironmentLifecycleStatus = "DELETE_FAILED" )
Enum values for EnvironmentLifecycleStatus
func (EnvironmentLifecycleStatus) MarshalValue ¶ added in v0.8.0
func (enum EnvironmentLifecycleStatus) MarshalValue() (string, error)
func (EnvironmentLifecycleStatus) MarshalValueBuf ¶ added in v0.8.0
func (enum EnvironmentLifecycleStatus) MarshalValueBuf(b []byte) ([]byte, error)
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"` // 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 Permissions `locationName:"permissions" type:"string" enum:"true"` // 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.
func (EnvironmentMember) String ¶
func (s EnvironmentMember) String() string
String returns the string representation
type EnvironmentStatus ¶
type EnvironmentStatus string
const ( EnvironmentStatusError EnvironmentStatus = "error" EnvironmentStatusCreating EnvironmentStatus = "creating" EnvironmentStatusConnecting EnvironmentStatus = "connecting" EnvironmentStatusReady EnvironmentStatus = "ready" EnvironmentStatusStopping EnvironmentStatus = "stopping" EnvironmentStatusStopped EnvironmentStatus = "stopped" EnvironmentStatusDeleting EnvironmentStatus = "deleting" )
Enum values for EnvironmentStatus
func (EnvironmentStatus) MarshalValue ¶ added in v0.3.0
func (enum EnvironmentStatus) MarshalValue() (string, error)
func (EnvironmentStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum EnvironmentStatus) MarshalValueBuf(b []byte) ([]byte, error)
type EnvironmentType ¶
type EnvironmentType string
const ( EnvironmentTypeSsh EnvironmentType = "ssh" EnvironmentTypeEc2 EnvironmentType = "ec2" )
Enum values for EnvironmentType
func (EnvironmentType) MarshalValue ¶ added in v0.3.0
func (enum EnvironmentType) MarshalValue() (string, error)
func (EnvironmentType) MarshalValueBuf ¶ added in v0.3.0
func (enum EnvironmentType) MarshalValueBuf(b []byte) ([]byte, error)
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 }
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 }
func (ListEnvironmentsOutput) String ¶
func (s ListEnvironmentsOutput) String() string
String returns the string representation
type ListEnvironmentsPaginator ¶ added in v0.9.0
ListEnvironmentsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListEnvironmentsPaginator ¶ added in v0.9.0
func NewListEnvironmentsPaginator(req ListEnvironmentsRequest) ListEnvironmentsPaginator
NewListEnvironmentsRequestPaginator returns a paginator for ListEnvironments. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListEnvironmentsRequest(input) p := cloud9.NewListEnvironmentsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListEnvironmentsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListEnvironmentsPaginator) CurrentPage() *ListEnvironmentsOutput
type ListEnvironmentsRequest ¶
type ListEnvironmentsRequest struct { *aws.Request Input *ListEnvironmentsInput Copy func(*ListEnvironmentsInput) ListEnvironmentsRequest }
ListEnvironmentsRequest is the request type for the ListEnvironments API operation.
func (ListEnvironmentsRequest) Send ¶
func (r ListEnvironmentsRequest) Send(ctx context.Context) (*ListEnvironmentsResponse, error)
Send marshals and sends the ListEnvironments API request.
type ListEnvironmentsResponse ¶ added in v0.9.0
type ListEnvironmentsResponse struct { *ListEnvironmentsOutput // contains filtered or unexported fields }
ListEnvironmentsResponse is the response type for the ListEnvironments API operation.
func (*ListEnvironmentsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListEnvironmentsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListEnvironments request.
type MemberPermissions ¶
type MemberPermissions string
const ( MemberPermissionsReadWrite MemberPermissions = "read-write" MemberPermissionsReadOnly MemberPermissions = "read-only" )
Enum values for MemberPermissions
func (MemberPermissions) MarshalValue ¶ added in v0.3.0
func (enum MemberPermissions) MarshalValue() (string, error)
func (MemberPermissions) MarshalValueBuf ¶ added in v0.3.0
func (enum MemberPermissions) MarshalValueBuf(b []byte) ([]byte, error)
type Permissions ¶
type Permissions string
const ( PermissionsOwner Permissions = "owner" PermissionsReadWrite Permissions = "read-write" PermissionsReadOnly Permissions = "read-only" )
Enum values for Permissions
func (Permissions) MarshalValue ¶ added in v0.3.0
func (enum Permissions) MarshalValue() (string, error)
func (Permissions) MarshalValueBuf ¶ added in v0.3.0
func (enum Permissions) MarshalValueBuf(b []byte) ([]byte, error)
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"` // A replacement name for the environment. Name *string `locationName:"name" min:"1" type:"string"` // contains filtered or unexported fields }
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 MemberPermissions `locationName:"permissions" type:"string" required:"true" enum:"true"` // 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 }
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 }
func (UpdateEnvironmentMembershipOutput) String ¶
func (s UpdateEnvironmentMembershipOutput) String() string
String returns the string representation
type UpdateEnvironmentMembershipRequest ¶
type UpdateEnvironmentMembershipRequest struct { *aws.Request Input *UpdateEnvironmentMembershipInput Copy func(*UpdateEnvironmentMembershipInput) UpdateEnvironmentMembershipRequest }
UpdateEnvironmentMembershipRequest is the request type for the UpdateEnvironmentMembership API operation.
func (UpdateEnvironmentMembershipRequest) Send ¶
func (r UpdateEnvironmentMembershipRequest) Send(ctx context.Context) (*UpdateEnvironmentMembershipResponse, error)
Send marshals and sends the UpdateEnvironmentMembership API request.
type UpdateEnvironmentMembershipResponse ¶ added in v0.9.0
type UpdateEnvironmentMembershipResponse struct { *UpdateEnvironmentMembershipOutput // contains filtered or unexported fields }
UpdateEnvironmentMembershipResponse is the response type for the UpdateEnvironmentMembership API operation.
func (*UpdateEnvironmentMembershipResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateEnvironmentMembershipResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateEnvironmentMembership request.
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (UpdateEnvironmentOutput) String ¶
func (s UpdateEnvironmentOutput) String() string
String returns the string representation
type UpdateEnvironmentRequest ¶
type UpdateEnvironmentRequest struct { *aws.Request Input *UpdateEnvironmentInput Copy func(*UpdateEnvironmentInput) UpdateEnvironmentRequest }
UpdateEnvironmentRequest is the request type for the UpdateEnvironment API operation.
func (UpdateEnvironmentRequest) Send ¶
func (r UpdateEnvironmentRequest) Send(ctx context.Context) (*UpdateEnvironmentResponse, error)
Send marshals and sends the UpdateEnvironment API request.
type UpdateEnvironmentResponse ¶ added in v0.9.0
type UpdateEnvironmentResponse struct { *UpdateEnvironmentOutput // contains filtered or unexported fields }
UpdateEnvironmentResponse is the response type for the UpdateEnvironment API operation.
func (*UpdateEnvironmentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateEnvironmentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateEnvironment request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateEnvironmentEC2.go
- api_op_CreateEnvironmentMembership.go
- api_op_DeleteEnvironment.go
- api_op_DeleteEnvironmentMembership.go
- api_op_DescribeEnvironmentMemberships.go
- api_op_DescribeEnvironmentStatus.go
- api_op_DescribeEnvironments.go
- api_op_ListEnvironments.go
- api_op_UpdateEnvironment.go
- api_op_UpdateEnvironmentMembership.go
- api_types.go
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. |