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 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
- type Cloud9
- func (c *Cloud9) CreateEnvironmentEC2Request(input *CreateEnvironmentEC2Input) CreateEnvironmentEC2Request
- func (c *Cloud9) CreateEnvironmentMembershipRequest(input *CreateEnvironmentMembershipInput) CreateEnvironmentMembershipRequest
- func (c *Cloud9) DeleteEnvironmentMembershipRequest(input *DeleteEnvironmentMembershipInput) DeleteEnvironmentMembershipRequest
- func (c *Cloud9) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) DeleteEnvironmentRequest
- func (c *Cloud9) DescribeEnvironmentMembershipsRequest(input *DescribeEnvironmentMembershipsInput) DescribeEnvironmentMembershipsRequest
- func (c *Cloud9) DescribeEnvironmentStatusRequest(input *DescribeEnvironmentStatusInput) DescribeEnvironmentStatusRequest
- func (c *Cloud9) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) DescribeEnvironmentsRequest
- func (c *Cloud9) ListEnvironmentsRequest(input *ListEnvironmentsInput) ListEnvironmentsRequest
- func (c *Cloud9) UpdateEnvironmentMembershipRequest(input *UpdateEnvironmentMembershipInput) UpdateEnvironmentMembershipRequest
- func (c *Cloud9) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) UpdateEnvironmentRequest
- type CreateEnvironmentEC2Input
- type CreateEnvironmentEC2Output
- type CreateEnvironmentEC2Request
- type CreateEnvironmentMembershipInput
- type CreateEnvironmentMembershipOutput
- type CreateEnvironmentMembershipRequest
- type DeleteEnvironmentInput
- type DeleteEnvironmentMembershipInput
- type DeleteEnvironmentMembershipOutput
- type DeleteEnvironmentMembershipRequest
- type DeleteEnvironmentOutput
- type DeleteEnvironmentRequest
- type DescribeEnvironmentMembershipsInput
- type DescribeEnvironmentMembershipsOutput
- type DescribeEnvironmentMembershipsPager
- type DescribeEnvironmentMembershipsRequest
- type DescribeEnvironmentStatusInput
- type DescribeEnvironmentStatusOutput
- type DescribeEnvironmentStatusRequest
- type DescribeEnvironmentsInput
- type DescribeEnvironmentsOutput
- type DescribeEnvironmentsRequest
- type Environment
- type EnvironmentMember
- type EnvironmentStatus
- type EnvironmentType
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListEnvironmentsPager
- type ListEnvironmentsRequest
- type MemberPermissions
- type Permissions
- type UpdateEnvironmentInput
- type UpdateEnvironmentMembershipInput
- type UpdateEnvironmentMembershipOutput
- type UpdateEnvironmentMembershipRequest
- type UpdateEnvironmentOutput
- type UpdateEnvironmentRequest
Examples ¶
- Cloud9.CreateEnvironmentEC2Request (Shared00)
- Cloud9.CreateEnvironmentMembershipRequest (Shared00)
- Cloud9.DeleteEnvironmentMembershipRequest (Shared00)
- Cloud9.DeleteEnvironmentRequest (Shared00)
- Cloud9.DescribeEnvironmentMembershipsRequest (Shared00)
- Cloud9.DescribeEnvironmentMembershipsRequest (Shared01)
- Cloud9.DescribeEnvironmentMembershipsRequest (Shared02)
- Cloud9.DescribeEnvironmentStatusRequest (Shared00)
- Cloud9.DescribeEnvironmentsRequest (Shared00)
- Cloud9.ListEnvironmentsRequest (Shared00)
- Cloud9.UpdateEnvironmentMembershipRequest (Shared00)
- Cloud9.UpdateEnvironmentRequest (Shared00)
Constants ¶
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" )
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 ¶
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 ¶
New creates a new instance of the Cloud9 client with a config.
Example:
// Create a Cloud9 client from just a config. svc := cloud9.New(myConfig)
func (*Cloud9) CreateEnvironmentEC2Request ¶
func (c *Cloud9) 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 the CreateEnvironmentEC2Request method. req := client.CreateEnvironmentEC2Request(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentEC2
func (*Cloud9) CreateEnvironmentMembershipRequest ¶
func (c *Cloud9) 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 the CreateEnvironmentMembershipRequest method. req := client.CreateEnvironmentMembershipRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/CreateEnvironmentMembership
func (*Cloud9) DeleteEnvironmentMembershipRequest ¶
func (c *Cloud9) 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 the DeleteEnvironmentMembershipRequest method. req := client.DeleteEnvironmentMembershipRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironmentMembership
func (*Cloud9) DeleteEnvironmentRequest ¶
func (c *Cloud9) 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 the DeleteEnvironmentRequest method. req := client.DeleteEnvironmentRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DeleteEnvironment
func (*Cloud9) DescribeEnvironmentMembershipsRequest ¶
func (c *Cloud9) 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 the DescribeEnvironmentMembershipsRequest method. req := client.DescribeEnvironmentMembershipsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentMemberships
func (*Cloud9) DescribeEnvironmentStatusRequest ¶
func (c *Cloud9) 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 the DescribeEnvironmentStatusRequest method. req := client.DescribeEnvironmentStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatus
func (*Cloud9) DescribeEnvironmentsRequest ¶
func (c *Cloud9) 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 the DescribeEnvironmentsRequest method. req := client.DescribeEnvironmentsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironments
func (*Cloud9) ListEnvironmentsRequest ¶
func (c *Cloud9) 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 the ListEnvironmentsRequest method. req := client.ListEnvironmentsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/ListEnvironments
func (*Cloud9) UpdateEnvironmentMembershipRequest ¶
func (c *Cloud9) 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 the UpdateEnvironmentMembershipRequest method. req := client.UpdateEnvironmentMembershipRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/UpdateEnvironmentMembership
func (*Cloud9) UpdateEnvironmentRequest ¶
func (c *Cloud9) 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 the UpdateEnvironmentRequest method. req := client.UpdateEnvironmentRequest(params) resp, err := req.Send() 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s CreateEnvironmentEC2Output) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the CreateEnvironmentEC2 API operation.
func (CreateEnvironmentEC2Request) Send ¶
func (r CreateEnvironmentEC2Request) Send() (*CreateEnvironmentEC2Output, error)
Send marshals and sends the CreateEnvironmentEC2 API 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s CreateEnvironmentMembershipOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the CreateEnvironmentMembership API operation.
func (CreateEnvironmentMembershipRequest) Send ¶
func (r CreateEnvironmentMembershipRequest) Send() (*CreateEnvironmentMembershipOutput, error)
Send marshals and sends the CreateEnvironmentMembership API 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 }
Please also see 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) 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 }
Please also see 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) 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
}
Please also see 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) SDKResponseMetadata ¶
func (s DeleteEnvironmentMembershipOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DeleteEnvironmentMembership API operation.
func (DeleteEnvironmentMembershipRequest) Send ¶
func (r DeleteEnvironmentMembershipRequest) Send() (*DeleteEnvironmentMembershipOutput, error)
Send marshals and sends the DeleteEnvironmentMembership API request.
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct {
// contains filtered or unexported fields
}
Please also see 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) SDKResponseMetadata ¶
func (s DeleteEnvironmentOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DeleteEnvironment API operation.
func (DeleteEnvironmentRequest) Send ¶
func (r DeleteEnvironmentRequest) Send() (*DeleteEnvironmentOutput, error)
Send marshals and sends the DeleteEnvironment API 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s DescribeEnvironmentMembershipsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeEnvironmentMembershipsOutput) String ¶
func (s DescribeEnvironmentMembershipsOutput) String() string
String returns the string representation
type DescribeEnvironmentMembershipsPager ¶ added in v0.3.0
DescribeEnvironmentMembershipsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*DescribeEnvironmentMembershipsPager) CurrentPage ¶ added in v0.3.0
func (p *DescribeEnvironmentMembershipsPager) CurrentPage() *DescribeEnvironmentMembershipsOutput
type DescribeEnvironmentMembershipsRequest ¶
type DescribeEnvironmentMembershipsRequest struct { *aws.Request Input *DescribeEnvironmentMembershipsInput Copy func(*DescribeEnvironmentMembershipsInput) DescribeEnvironmentMembershipsRequest }
DescribeEnvironmentMembershipsRequest is a API request type for the DescribeEnvironmentMemberships API operation.
func (*DescribeEnvironmentMembershipsRequest) Paginate ¶ added in v0.3.0
func (p *DescribeEnvironmentMembershipsRequest) Paginate(opts ...aws.Option) DescribeEnvironmentMembershipsPager
Paginate pages iterates over the pages of a DescribeEnvironmentMembershipsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeEnvironmentMemberships operation. req := client.DescribeEnvironmentMembershipsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (DescribeEnvironmentMembershipsRequest) Send ¶
func (r DescribeEnvironmentMembershipsRequest) Send() (*DescribeEnvironmentMembershipsOutput, error)
Send marshals and sends the DescribeEnvironmentMemberships API 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s DescribeEnvironmentStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribeEnvironmentStatus API operation.
func (DescribeEnvironmentStatusRequest) Send ¶
func (r DescribeEnvironmentStatusRequest) Send() (*DescribeEnvironmentStatusOutput, error)
Send marshals and sends the DescribeEnvironmentStatus API 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s DescribeEnvironmentsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribeEnvironments API operation.
func (DescribeEnvironmentsRequest) Send ¶
func (r DescribeEnvironmentsRequest) Send() (*DescribeEnvironmentsOutput, error)
Send marshals and sends the DescribeEnvironments API 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 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. Please also see 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) 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 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. Please also see 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) 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s ListEnvironmentsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListEnvironmentsOutput) String ¶
func (s ListEnvironmentsOutput) String() string
String returns the string representation
type ListEnvironmentsPager ¶ added in v0.3.0
ListEnvironmentsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListEnvironmentsPager) CurrentPage ¶ added in v0.3.0
func (p *ListEnvironmentsPager) CurrentPage() *ListEnvironmentsOutput
type ListEnvironmentsRequest ¶
type ListEnvironmentsRequest struct { *aws.Request Input *ListEnvironmentsInput Copy func(*ListEnvironmentsInput) ListEnvironmentsRequest }
ListEnvironmentsRequest is a API request type for the ListEnvironments API operation.
func (*ListEnvironmentsRequest) Paginate ¶ added in v0.3.0
func (p *ListEnvironmentsRequest) Paginate(opts ...aws.Option) ListEnvironmentsPager
Paginate pages iterates over the pages of a ListEnvironmentsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEnvironments operation. req := client.ListEnvironmentsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListEnvironmentsRequest) Send ¶
func (r ListEnvironmentsRequest) Send() (*ListEnvironmentsOutput, error)
Send marshals and sends the ListEnvironments API 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 }
Please also see 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) 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 }
Please also see 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) 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 }
Please also see 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) SDKResponseMetadata ¶
func (s UpdateEnvironmentMembershipOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the UpdateEnvironmentMembership API operation.
func (UpdateEnvironmentMembershipRequest) Send ¶
func (r UpdateEnvironmentMembershipRequest) Send() (*UpdateEnvironmentMembershipOutput, error)
Send marshals and sends the UpdateEnvironmentMembership API request.
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput struct {
// contains filtered or unexported fields
}
Please also see 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) SDKResponseMetadata ¶
func (s UpdateEnvironmentOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the UpdateEnvironment API operation.
func (UpdateEnvironmentRequest) Send ¶
func (r UpdateEnvironmentRequest) Send() (*UpdateEnvironmentOutput, error)
Send marshals and sends the UpdateEnvironment API request.
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. |