codestar

package
v0.21.0 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 20

Documentation

Overview

Package codestar provides the client and types for making API requests to CodeStar.

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

  • DeleteProject, which deletes a project.

  • DescribeProject, which lists the attributes of a project.

  • ListProjects, which lists all projects associated with your AWS account.

  • ListResources, which lists the resources associated with a project.

  • ListTagsForProject, which lists the tags associated with a project.

  • TagProject, which adds tags to a project.

  • UntagProject, which removes tags from a project.

  • UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

  • AssociateTeamMember, which adds an IAM user to the team for a project.

  • DisassociateTeamMember, which removes an IAM user from the team for a project.

  • ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.

  • UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

  • CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.

  • DeleteUserProfile, which deletes all user profile information across all projects.

  • DescribeUserProfile, which describes the profile of a user.

  • ListUserProfiles, which lists all user profiles.

  • UpdateUserProfile, which updates the profile for a user.

See https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19 for more information on this service.

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

Using the Client

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

Index

Constants

View Source
const (
	ServiceName = "CodeStar" // Service's name
	ServiceID   = "CodeStar" // Service's identifier
	EndpointsID = "codestar" // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Another modification is being made. That modification must complete before
	// you can make your change.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The next token is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidServiceRoleException for service response error code
	// "InvalidServiceRoleException".
	//
	// The service role is not valid.
	ErrCodeInvalidServiceRoleException = "InvalidServiceRoleException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A resource limit has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeProjectAlreadyExistsException for service response error code
	// "ProjectAlreadyExistsException".
	//
	// An AWS CodeStar project with the same ID already exists in this region for
	// the AWS account. AWS CodeStar project IDs must be unique within a region
	// for the AWS account.
	ErrCodeProjectAlreadyExistsException = "ProjectAlreadyExistsException"

	// ErrCodeProjectConfigurationException for service response error code
	// "ProjectConfigurationException".
	//
	// Project configuration information is required but not specified.
	ErrCodeProjectConfigurationException = "ProjectConfigurationException"

	// ErrCodeProjectCreationFailedException for service response error code
	// "ProjectCreationFailedException".
	//
	// The project creation request was valid, but a nonspecific exception or error
	// occurred during project creation. The project could not be created in AWS
	// CodeStar.
	ErrCodeProjectCreationFailedException = "ProjectCreationFailedException"

	// ErrCodeProjectNotFoundException for service response error code
	// "ProjectNotFoundException".
	//
	// The specified AWS CodeStar project was not found.
	ErrCodeProjectNotFoundException = "ProjectNotFoundException"

	// ErrCodeTeamMemberAlreadyAssociatedException for service response error code
	// "TeamMemberAlreadyAssociatedException".
	//
	// The team member is already associated with a role in this project.
	ErrCodeTeamMemberAlreadyAssociatedException = "TeamMemberAlreadyAssociatedException"

	// ErrCodeTeamMemberNotFoundException for service response error code
	// "TeamMemberNotFoundException".
	//
	// The specified team member was not found.
	ErrCodeTeamMemberNotFoundException = "TeamMemberNotFoundException"

	// ErrCodeUserProfileAlreadyExistsException for service response error code
	// "UserProfileAlreadyExistsException".
	//
	// A user profile with that name already exists in this region for the AWS account.
	// AWS CodeStar user profile names must be unique within a region for the AWS
	// account.
	ErrCodeUserProfileAlreadyExistsException = "UserProfileAlreadyExistsException"

	// ErrCodeUserProfileNotFoundException for service response error code
	// "UserProfileNotFoundException".
	//
	// The user profile was not found.
	ErrCodeUserProfileNotFoundException = "UserProfileNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The specified input is either not valid, or it could not be validated.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateTeamMemberInput

type AssociateTeamMemberInput struct {

	// A user- or system-generated token that identifies the entity that requested
	// the team member association to the project. This token can be used to repeat
	// the request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`

	// The ID of the project to which you will add the IAM user.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"2" type:"string" required:"true"`

	// The AWS CodeStar project role that will apply to this user. This role determines
	// what actions a user can take in an AWS CodeStar project.
	//
	// ProjectRole is a required field
	ProjectRole *string `locationName:"projectRole" type:"string" required:"true"`

	// Whether the team member is allowed to use an SSH public/private key pair
	// to remotely access project resources, for example Amazon EC2 instances.
	RemoteAccessAllowed *bool `locationName:"remoteAccessAllowed" type:"boolean"`

	// The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS
	// CodeStar project.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateTeamMemberInput) String

func (s AssociateTeamMemberInput) String() string

String returns the string representation

func (*AssociateTeamMemberInput) Validate

func (s *AssociateTeamMemberInput) Validate() error

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

type AssociateTeamMemberOutput

type AssociateTeamMemberOutput struct {

	// The user- or system-generated token from the initial request that can be
	// used to repeat the request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateTeamMemberOutput) String

func (s AssociateTeamMemberOutput) String() string

String returns the string representation

type AssociateTeamMemberRequest

type AssociateTeamMemberRequest struct {
	*aws.Request
	Input *AssociateTeamMemberInput
	Copy  func(*AssociateTeamMemberInput) AssociateTeamMemberRequest
}

AssociateTeamMemberRequest is the request type for the AssociateTeamMember API operation.

func (AssociateTeamMemberRequest) Send

Send marshals and sends the AssociateTeamMember API request.

type AssociateTeamMemberResponse added in v0.9.0

type AssociateTeamMemberResponse struct {
	*AssociateTeamMemberOutput
	// contains filtered or unexported fields
}

AssociateTeamMemberResponse is the response type for the AssociateTeamMember API operation.

func (*AssociateTeamMemberResponse) SDKResponseMetdata added in v0.9.0

func (r *AssociateTeamMemberResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateTeamMember request.

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to CodeStar. 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

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := codestar.New(myConfig)

func (*Client) AssociateTeamMemberRequest added in v0.9.0

func (c *Client) AssociateTeamMemberRequest(input *AssociateTeamMemberInput) AssociateTeamMemberRequest

AssociateTeamMemberRequest returns a request value for making API operation for AWS CodeStar.

Adds an IAM user to the team for an AWS CodeStar project.

// Example sending a request using AssociateTeamMemberRequest.
req := client.AssociateTeamMemberRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/AssociateTeamMember

func (*Client) CreateProjectRequest added in v0.9.0

func (c *Client) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest

CreateProjectRequest returns a request value for making API operation for AWS CodeStar.

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

// Example sending a request using CreateProjectRequest.
req := client.CreateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateProject

func (*Client) CreateUserProfileRequest added in v0.9.0

func (c *Client) CreateUserProfileRequest(input *CreateUserProfileInput) CreateUserProfileRequest

CreateUserProfileRequest returns a request value for making API operation for AWS CodeStar.

Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

// Example sending a request using CreateUserProfileRequest.
req := client.CreateUserProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateUserProfile

func (*Client) DeleteProjectRequest added in v0.9.0

func (c *Client) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest

DeleteProjectRequest returns a request value for making API operation for AWS CodeStar.

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

// Example sending a request using DeleteProjectRequest.
req := client.DeleteProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteProject

func (*Client) DeleteUserProfileRequest added in v0.9.0

func (c *Client) DeleteUserProfileRequest(input *DeleteUserProfileInput) DeleteUserProfileRequest

DeleteUserProfileRequest returns a request value for making API operation for AWS CodeStar.

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

// Example sending a request using DeleteUserProfileRequest.
req := client.DeleteUserProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteUserProfile

func (*Client) DescribeProjectRequest added in v0.9.0

func (c *Client) DescribeProjectRequest(input *DescribeProjectInput) DescribeProjectRequest

DescribeProjectRequest returns a request value for making API operation for AWS CodeStar.

Describes a project and its resources.

// Example sending a request using DescribeProjectRequest.
req := client.DescribeProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeProject

func (*Client) DescribeUserProfileRequest added in v0.9.0

func (c *Client) DescribeUserProfileRequest(input *DescribeUserProfileInput) DescribeUserProfileRequest

DescribeUserProfileRequest returns a request value for making API operation for AWS CodeStar.

Describes a user in AWS CodeStar and the user attributes across all projects.

// Example sending a request using DescribeUserProfileRequest.
req := client.DescribeUserProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeUserProfile

func (*Client) DisassociateTeamMemberRequest added in v0.9.0

func (c *Client) DisassociateTeamMemberRequest(input *DisassociateTeamMemberInput) DisassociateTeamMemberRequest

DisassociateTeamMemberRequest returns a request value for making API operation for AWS CodeStar.

Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.

// Example sending a request using DisassociateTeamMemberRequest.
req := client.DisassociateTeamMemberRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DisassociateTeamMember

func (*Client) ListProjectsRequest added in v0.9.0

func (c *Client) ListProjectsRequest(input *ListProjectsInput) ListProjectsRequest

ListProjectsRequest returns a request value for making API operation for AWS CodeStar.

Lists all projects in AWS CodeStar associated with your AWS account.

// Example sending a request using ListProjectsRequest.
req := client.ListProjectsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListProjects

func (*Client) ListResourcesRequest added in v0.9.0

func (c *Client) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest

ListResourcesRequest returns a request value for making API operation for AWS CodeStar.

Lists resources associated with a project in AWS CodeStar.

// Example sending a request using ListResourcesRequest.
req := client.ListResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListResources

func (*Client) ListTagsForProjectRequest added in v0.9.0

func (c *Client) ListTagsForProjectRequest(input *ListTagsForProjectInput) ListTagsForProjectRequest

ListTagsForProjectRequest returns a request value for making API operation for AWS CodeStar.

Gets the tags for a project.

// Example sending a request using ListTagsForProjectRequest.
req := client.ListTagsForProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTagsForProject

func (*Client) ListTeamMembersRequest added in v0.9.0

func (c *Client) ListTeamMembersRequest(input *ListTeamMembersInput) ListTeamMembersRequest

ListTeamMembersRequest returns a request value for making API operation for AWS CodeStar.

Lists all team members associated with a project.

// Example sending a request using ListTeamMembersRequest.
req := client.ListTeamMembersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTeamMembers

func (*Client) ListUserProfilesRequest added in v0.9.0

func (c *Client) ListUserProfilesRequest(input *ListUserProfilesInput) ListUserProfilesRequest

ListUserProfilesRequest returns a request value for making API operation for AWS CodeStar.

Lists all the user profiles configured for your AWS account in AWS CodeStar.

// Example sending a request using ListUserProfilesRequest.
req := client.ListUserProfilesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListUserProfiles

func (*Client) TagProjectRequest added in v0.9.0

func (c *Client) TagProjectRequest(input *TagProjectInput) TagProjectRequest

TagProjectRequest returns a request value for making API operation for AWS CodeStar.

Adds tags to a project.

// Example sending a request using TagProjectRequest.
req := client.TagProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/TagProject

func (*Client) UntagProjectRequest added in v0.9.0

func (c *Client) UntagProjectRequest(input *UntagProjectInput) UntagProjectRequest

UntagProjectRequest returns a request value for making API operation for AWS CodeStar.

Removes tags from a project.

// Example sending a request using UntagProjectRequest.
req := client.UntagProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UntagProject

func (*Client) UpdateProjectRequest added in v0.9.0

func (c *Client) UpdateProjectRequest(input *UpdateProjectInput) UpdateProjectRequest

UpdateProjectRequest returns a request value for making API operation for AWS CodeStar.

Updates a project in AWS CodeStar.

// Example sending a request using UpdateProjectRequest.
req := client.UpdateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateProject

func (*Client) UpdateTeamMemberRequest added in v0.9.0

func (c *Client) UpdateTeamMemberRequest(input *UpdateTeamMemberInput) UpdateTeamMemberRequest

UpdateTeamMemberRequest returns a request value for making API operation for AWS CodeStar.

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.

// Example sending a request using UpdateTeamMemberRequest.
req := client.UpdateTeamMemberRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateTeamMember

func (*Client) UpdateUserProfileRequest added in v0.9.0

func (c *Client) UpdateUserProfileRequest(input *UpdateUserProfileInput) UpdateUserProfileRequest

UpdateUserProfileRequest returns a request value for making API operation for AWS CodeStar.

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

// Example sending a request using UpdateUserProfileRequest.
req := client.UpdateUserProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateUserProfile

type Code added in v0.6.0

type Code struct {

	// The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit
	// or GitHub. After AWS CodeStar provisions the new repository, the source code
	// files provided with the project request are placed in the repository.
	//
	// Destination is a required field
	Destination *CodeDestination `locationName:"destination" type:"structure" required:"true"`

	// The location where the source code files provided with the project request
	// are stored. AWS CodeStar retrieves the files during project creation.
	//
	// Source is a required field
	Source *CodeSource `locationName:"source" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Location and destination information about the source code files provided with the project request. The source code is uploaded to the new project source repository after project creation.

func (Code) String added in v0.6.0

func (s Code) String() string

String returns the string representation

func (*Code) Validate added in v0.6.0

func (s *Code) Validate() error

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

type CodeCommitCodeDestination added in v0.6.0

type CodeCommitCodeDestination struct {

	// The name of the AWS CodeCommit repository to be created in AWS CodeStar.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

func (CodeCommitCodeDestination) String added in v0.6.0

func (s CodeCommitCodeDestination) String() string

String returns the string representation

func (*CodeCommitCodeDestination) Validate added in v0.6.0

func (s *CodeCommitCodeDestination) Validate() error

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

type CodeDestination added in v0.6.0

type CodeDestination struct {

	// Information about the AWS CodeCommit repository to be created in AWS CodeStar.
	// This is where the source code files provided with the project request will
	// be uploaded after project creation.
	CodeCommit *CodeCommitCodeDestination `locationName:"codeCommit" type:"structure"`

	// Information about the GitHub repository to be created in AWS CodeStar. This
	// is where the source code files provided with the project request will be
	// uploaded after project creation.
	GitHub *GitHubCodeDestination `locationName:"gitHub" type:"structure"`
	// contains filtered or unexported fields
}

The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.

func (CodeDestination) String added in v0.6.0

func (s CodeDestination) String() string

String returns the string representation

func (*CodeDestination) Validate added in v0.6.0

func (s *CodeDestination) Validate() error

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

type CodeSource added in v0.6.0

type CodeSource struct {

	// Information about the Amazon S3 location where the source code files provided
	// with the project request are stored.
	//
	// S3 is a required field
	S3 *S3Location `locationName:"s3" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.

func (CodeSource) String added in v0.6.0

func (s CodeSource) String() string

String returns the string representation

func (*CodeSource) Validate added in v0.6.0

func (s *CodeSource) Validate() error

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

type CreateProjectInput

type CreateProjectInput struct {

	// A user- or system-generated token that identifies the entity that requested
	// project creation. This token can be used to repeat the request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`

	// The description of the project, if any.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The ID of the project to be created in AWS CodeStar.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// The display name for the project to be created in AWS CodeStar.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true" sensitive:"true"`

	// A list of the Code objects submitted with the project request. If this parameter
	// is specified, the request must also include the toolchain parameter.
	SourceCode []Code `locationName:"sourceCode" type:"list"`

	// The tags created for the project.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The name of the toolchain template file submitted with the project request.
	// If this parameter is specified, the request must also include the sourceCode
	// parameter.
	Toolchain *Toolchain `locationName:"toolchain" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateProjectInput) String

func (s CreateProjectInput) String() string

String returns the string representation

func (*CreateProjectInput) Validate

func (s *CreateProjectInput) Validate() error

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

type CreateProjectOutput

type CreateProjectOutput struct {

	// The Amazon Resource Name (ARN) of the created project.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// A user- or system-generated token that identifies the entity that requested
	// project creation.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// Reserved for future use.
	ProjectTemplateId *string `locationName:"projectTemplateId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProjectOutput) String

func (s CreateProjectOutput) String() string

String returns the string representation

type CreateProjectRequest

type CreateProjectRequest struct {
	*aws.Request
	Input *CreateProjectInput
	Copy  func(*CreateProjectInput) CreateProjectRequest
}

CreateProjectRequest is the request type for the CreateProject API operation.

func (CreateProjectRequest) Send

Send marshals and sends the CreateProject API request.

type CreateProjectResponse added in v0.9.0

type CreateProjectResponse struct {
	*CreateProjectOutput
	// contains filtered or unexported fields
}

CreateProjectResponse is the response type for the CreateProject API operation.

func (*CreateProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProject request.

type CreateUserProfileInput

type CreateUserProfileInput struct {

	// The name that will be displayed as the friendly name for the user in AWS
	// CodeStar.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true" sensitive:"true"`

	// The email address that will be displayed as part of the user's profile in
	// AWS CodeStar.
	//
	// EmailAddress is a required field
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" required:"true" sensitive:"true"`

	// The SSH public key associated with the user in AWS CodeStar. If a project
	// owner allows the user remote access to project resources, this public key
	// will be used along with the user's private key for SSH access.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The Amazon Resource Name (ARN) of the user in IAM.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserProfileInput) String

func (s CreateUserProfileInput) String() string

String returns the string representation

func (*CreateUserProfileInput) Validate

func (s *CreateUserProfileInput) Validate() error

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

type CreateUserProfileOutput

type CreateUserProfileOutput struct {

	// The date the user profile was created, in timestamp format.
	CreatedTimestamp *time.Time `locationName:"createdTimestamp" type:"timestamp"`

	// The name that is displayed as the friendly name for the user in AWS CodeStar.
	DisplayName *string `locationName:"displayName" min:"1" type:"string" sensitive:"true"`

	// The email address that is displayed as part of the user's profile in AWS
	// CodeStar.
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" sensitive:"true"`

	// The date the user profile was last modified, in timestamp format.
	LastModifiedTimestamp *time.Time `locationName:"lastModifiedTimestamp" type:"timestamp"`

	// The SSH public key associated with the user in AWS CodeStar. This is the
	// public portion of the public/private keypair the user can use to access project
	// resources if a project owner allows the user remote access to those resources.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The Amazon Resource Name (ARN) of the user in IAM.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserProfileOutput) String

func (s CreateUserProfileOutput) String() string

String returns the string representation

type CreateUserProfileRequest

type CreateUserProfileRequest struct {
	*aws.Request
	Input *CreateUserProfileInput
	Copy  func(*CreateUserProfileInput) CreateUserProfileRequest
}

CreateUserProfileRequest is the request type for the CreateUserProfile API operation.

func (CreateUserProfileRequest) Send

Send marshals and sends the CreateUserProfile API request.

type CreateUserProfileResponse added in v0.9.0

type CreateUserProfileResponse struct {
	*CreateUserProfileOutput
	// contains filtered or unexported fields
}

CreateUserProfileResponse is the response type for the CreateUserProfile API operation.

func (*CreateUserProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateUserProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateUserProfile request.

type DeleteProjectInput

type DeleteProjectInput struct {

	// A user- or system-generated token that identifies the entity that requested
	// project deletion. This token can be used to repeat the request.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`

	// Whether to send a delete request for the primary stack in AWS CloudFormation
	// originally used to generate the project and its resources. This option will
	// delete all AWS resources for the project (except for any buckets in Amazon
	// S3) as well as deleting the project itself. Recommended for most use cases.
	DeleteStack *bool `locationName:"deleteStack" type:"boolean"`

	// The ID of the project to be deleted in AWS CodeStar.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProjectInput) String

func (s DeleteProjectInput) String() string

String returns the string representation

func (*DeleteProjectInput) Validate

func (s *DeleteProjectInput) Validate() error

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

type DeleteProjectOutput

type DeleteProjectOutput struct {

	// The Amazon Resource Name (ARN) of the deleted project.
	ProjectArn *string `locationName:"projectArn" type:"string"`

	// The ID of the primary stack in AWS CloudFormation that will be deleted as
	// part of deleting the project and its resources.
	StackId *string `locationName:"stackId" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteProjectOutput) String

func (s DeleteProjectOutput) String() string

String returns the string representation

type DeleteProjectRequest

type DeleteProjectRequest struct {
	*aws.Request
	Input *DeleteProjectInput
	Copy  func(*DeleteProjectInput) DeleteProjectRequest
}

DeleteProjectRequest is the request type for the DeleteProject API operation.

func (DeleteProjectRequest) Send

Send marshals and sends the DeleteProject API request.

type DeleteProjectResponse added in v0.9.0

type DeleteProjectResponse struct {
	*DeleteProjectOutput
	// contains filtered or unexported fields
}

DeleteProjectResponse is the response type for the DeleteProject API operation.

func (*DeleteProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProject request.

type DeleteUserProfileInput

type DeleteUserProfileInput struct {

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

func (DeleteUserProfileInput) String

func (s DeleteUserProfileInput) String() string

String returns the string representation

func (*DeleteUserProfileInput) Validate

func (s *DeleteUserProfileInput) Validate() error

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

type DeleteUserProfileOutput

type DeleteUserProfileOutput struct {

	// The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserProfileOutput) String

func (s DeleteUserProfileOutput) String() string

String returns the string representation

type DeleteUserProfileRequest

type DeleteUserProfileRequest struct {
	*aws.Request
	Input *DeleteUserProfileInput
	Copy  func(*DeleteUserProfileInput) DeleteUserProfileRequest
}

DeleteUserProfileRequest is the request type for the DeleteUserProfile API operation.

func (DeleteUserProfileRequest) Send

Send marshals and sends the DeleteUserProfile API request.

type DeleteUserProfileResponse added in v0.9.0

type DeleteUserProfileResponse struct {
	*DeleteUserProfileOutput
	// contains filtered or unexported fields
}

DeleteUserProfileResponse is the response type for the DeleteUserProfile API operation.

func (*DeleteUserProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteUserProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteUserProfile request.

type DescribeProjectInput

type DescribeProjectInput struct {

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProjectInput) String

func (s DescribeProjectInput) String() string

String returns the string representation

func (*DescribeProjectInput) Validate

func (s *DescribeProjectInput) Validate() error

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

type DescribeProjectOutput

type DescribeProjectOutput struct {

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

	// A user- or system-generated token that identifies the entity that requested
	// project creation.
	ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"`

	// The date and time the project was created, in timestamp format.
	CreatedTimeStamp *time.Time `locationName:"createdTimeStamp" type:"timestamp"`

	// The description of the project, if any.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The ID of the project.
	Id *string `locationName:"id" min:"2" type:"string"`

	// The display name for the project.
	Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"`

	// The ID for the AWS CodeStar project template used to create the project.
	ProjectTemplateId *string `locationName:"projectTemplateId" min:"1" type:"string"`

	// The ID of the primary stack in AWS CloudFormation used to generate resources
	// for the project.
	StackId *string `locationName:"stackId" type:"string"`

	// The project creation or deletion status.
	Status *ProjectStatus `locationName:"status" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeProjectOutput) String

func (s DescribeProjectOutput) String() string

String returns the string representation

type DescribeProjectRequest

type DescribeProjectRequest struct {
	*aws.Request
	Input *DescribeProjectInput
	Copy  func(*DescribeProjectInput) DescribeProjectRequest
}

DescribeProjectRequest is the request type for the DescribeProject API operation.

func (DescribeProjectRequest) Send

Send marshals and sends the DescribeProject API request.

type DescribeProjectResponse added in v0.9.0

type DescribeProjectResponse struct {
	*DescribeProjectOutput
	// contains filtered or unexported fields
}

DescribeProjectResponse is the response type for the DescribeProject API operation.

func (*DescribeProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProject request.

type DescribeUserProfileInput

type DescribeUserProfileInput struct {

	// The Amazon Resource Name (ARN) of the user.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserProfileInput) String

func (s DescribeUserProfileInput) String() string

String returns the string representation

func (*DescribeUserProfileInput) Validate

func (s *DescribeUserProfileInput) Validate() error

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

type DescribeUserProfileOutput

type DescribeUserProfileOutput struct {

	// The date and time when the user profile was created in AWS CodeStar, in timestamp
	// format.
	//
	// CreatedTimestamp is a required field
	CreatedTimestamp *time.Time `locationName:"createdTimestamp" type:"timestamp" required:"true"`

	// The display name shown for the user in AWS CodeStar projects. For example,
	// this could be set to both first and last name ("Mary Major") or a single
	// name ("Mary"). The display name is also used to generate the initial icon
	// associated with the user in AWS CodeStar projects. If spaces are included
	// in the display name, the first character that appears after the space will
	// be used as the second character in the user initial icon. The initial icon
	// displays a maximum of two characters, so a display name with more than one
	// space (for example "Mary Jane Major") would generate an initial icon using
	// the first character and the first character after the space ("MJ", not "MM").
	DisplayName *string `locationName:"displayName" min:"1" type:"string" sensitive:"true"`

	// The email address for the user. Optional.
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" sensitive:"true"`

	// The date and time when the user profile was last modified, in timestamp format.
	//
	// LastModifiedTimestamp is a required field
	LastModifiedTimestamp *time.Time `locationName:"lastModifiedTimestamp" type:"timestamp" required:"true"`

	// The SSH public key associated with the user. This SSH public key is associated
	// with the user profile, and can be used in conjunction with the associated
	// private key for access to project resources, such as Amazon EC2 instances,
	// if a project owner grants remote access to those resources.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The Amazon Resource Name (ARN) of the user.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserProfileOutput) String

func (s DescribeUserProfileOutput) String() string

String returns the string representation

type DescribeUserProfileRequest

type DescribeUserProfileRequest struct {
	*aws.Request
	Input *DescribeUserProfileInput
	Copy  func(*DescribeUserProfileInput) DescribeUserProfileRequest
}

DescribeUserProfileRequest is the request type for the DescribeUserProfile API operation.

func (DescribeUserProfileRequest) Send

Send marshals and sends the DescribeUserProfile API request.

type DescribeUserProfileResponse added in v0.9.0

type DescribeUserProfileResponse struct {
	*DescribeUserProfileOutput
	// contains filtered or unexported fields
}

DescribeUserProfileResponse is the response type for the DescribeUserProfile API operation.

func (*DescribeUserProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeUserProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUserProfile request.

type DisassociateTeamMemberInput

type DisassociateTeamMemberInput struct {

	// The ID of the AWS CodeStar project from which you want to remove a team member.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"2" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM user or group whom you want to
	// remove from the project.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateTeamMemberInput) String

String returns the string representation

func (*DisassociateTeamMemberInput) Validate

func (s *DisassociateTeamMemberInput) Validate() error

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

type DisassociateTeamMemberOutput

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

func (DisassociateTeamMemberOutput) String

String returns the string representation

type DisassociateTeamMemberRequest

type DisassociateTeamMemberRequest struct {
	*aws.Request
	Input *DisassociateTeamMemberInput
	Copy  func(*DisassociateTeamMemberInput) DisassociateTeamMemberRequest
}

DisassociateTeamMemberRequest is the request type for the DisassociateTeamMember API operation.

func (DisassociateTeamMemberRequest) Send

Send marshals and sends the DisassociateTeamMember API request.

type DisassociateTeamMemberResponse added in v0.9.0

type DisassociateTeamMemberResponse struct {
	*DisassociateTeamMemberOutput
	// contains filtered or unexported fields
}

DisassociateTeamMemberResponse is the response type for the DisassociateTeamMember API operation.

func (*DisassociateTeamMemberResponse) SDKResponseMetdata added in v0.9.0

func (r *DisassociateTeamMemberResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateTeamMember request.

type GitHubCodeDestination added in v0.6.0

type GitHubCodeDestination struct {

	// Description for the GitHub repository to be created in AWS CodeStar. This
	// description displays in GitHub after the repository is created.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Whether to enable issues for the GitHub repository.
	//
	// IssuesEnabled is a required field
	IssuesEnabled *bool `locationName:"issuesEnabled" type:"boolean" required:"true"`

	// Name of the GitHub repository to be created in AWS CodeStar.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The GitHub username for the owner of the GitHub repository to be created
	// in AWS CodeStar. If this repository should be owned by a GitHub organization,
	// provide its name.
	//
	// Owner is a required field
	Owner *string `locationName:"owner" min:"1" type:"string" required:"true"`

	// Whether the GitHub repository is to be a private repository.
	//
	// PrivateRepository is a required field
	PrivateRepository *bool `locationName:"privateRepository" type:"boolean" required:"true"`

	// The GitHub user's personal access token for the GitHub repository.
	//
	// Token is a required field
	Token *string `locationName:"token" min:"1" type:"string" required:"true" sensitive:"true"`

	// The type of GitHub repository to be created in AWS CodeStar. Valid values
	// are User or Organization.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

func (GitHubCodeDestination) String added in v0.6.0

func (s GitHubCodeDestination) String() string

String returns the string representation

func (*GitHubCodeDestination) Validate added in v0.6.0

func (s *GitHubCodeDestination) Validate() error

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

type ListProjectsInput

type ListProjectsInput struct {

	// The maximum amount of data that can be contained in a single set of results.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The continuation token to be used to return the next set of results, if the
	// results cannot be returned in one response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListProjectsInput) String

func (s ListProjectsInput) String() string

String returns the string representation

func (*ListProjectsInput) Validate

func (s *ListProjectsInput) Validate() error

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

type ListProjectsOutput

type ListProjectsOutput struct {

	// The continuation token to use when requesting the next set of results, if
	// there are more results to be returned.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of projects.
	//
	// Projects is a required field
	Projects []ProjectSummary `locationName:"projects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectsOutput) String

func (s ListProjectsOutput) String() string

String returns the string representation

type ListProjectsRequest

type ListProjectsRequest struct {
	*aws.Request
	Input *ListProjectsInput
	Copy  func(*ListProjectsInput) ListProjectsRequest
}

ListProjectsRequest is the request type for the ListProjects API operation.

func (ListProjectsRequest) Send

Send marshals and sends the ListProjects API request.

type ListProjectsResponse added in v0.9.0

type ListProjectsResponse struct {
	*ListProjectsOutput
	// contains filtered or unexported fields
}

ListProjectsResponse is the response type for the ListProjects API operation.

func (*ListProjectsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListProjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProjects request.

type ListResourcesInput

type ListResourcesInput struct {

	// The maximum amount of data that can be contained in a single set of results.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The continuation token for the next set of results, if the results cannot
	// be returned in one response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourcesInput) String

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate

func (s *ListResourcesInput) Validate() error

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

type ListResourcesOutput

type ListResourcesOutput struct {

	// The continuation token to use when requesting the next set of results, if
	// there are more results to be returned.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// An array of resources associated with the project.
	Resources []Resource `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

func (ListResourcesOutput) String

func (s ListResourcesOutput) String() string

String returns the string representation

type ListResourcesRequest

type ListResourcesRequest struct {
	*aws.Request
	Input *ListResourcesInput
	Copy  func(*ListResourcesInput) ListResourcesRequest
}

ListResourcesRequest is the request type for the ListResources API operation.

func (ListResourcesRequest) Send

Send marshals and sends the ListResources API request.

type ListResourcesResponse added in v0.9.0

type ListResourcesResponse struct {
	*ListResourcesOutput
	// contains filtered or unexported fields
}

ListResourcesResponse is the response type for the ListResources API operation.

func (*ListResourcesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListResources request.

type ListTagsForProjectInput

type ListTagsForProjectInput struct {

	// The ID of the project to get tags for.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// Reserved for future use.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// Reserved for future use.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTagsForProjectInput) String

func (s ListTagsForProjectInput) String() string

String returns the string representation

func (*ListTagsForProjectInput) Validate

func (s *ListTagsForProjectInput) Validate() error

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

type ListTagsForProjectOutput

type ListTagsForProjectOutput struct {

	// Reserved for future use.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The tags for the project.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForProjectOutput) String

func (s ListTagsForProjectOutput) String() string

String returns the string representation

type ListTagsForProjectRequest

type ListTagsForProjectRequest struct {
	*aws.Request
	Input *ListTagsForProjectInput
	Copy  func(*ListTagsForProjectInput) ListTagsForProjectRequest
}

ListTagsForProjectRequest is the request type for the ListTagsForProject API operation.

func (ListTagsForProjectRequest) Send

Send marshals and sends the ListTagsForProject API request.

type ListTagsForProjectResponse added in v0.9.0

type ListTagsForProjectResponse struct {
	*ListTagsForProjectOutput
	// contains filtered or unexported fields
}

ListTagsForProjectResponse is the response type for the ListTagsForProject API operation.

func (*ListTagsForProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTagsForProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForProject request.

type ListTeamMembersInput

type ListTeamMembersInput struct {

	// The maximum number of team members you want returned in a response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The continuation token for the next set of results, if the results cannot
	// be returned in one response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The ID of the project for which you want to list team members.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTeamMembersInput) String

func (s ListTeamMembersInput) String() string

String returns the string representation

func (*ListTeamMembersInput) Validate

func (s *ListTeamMembersInput) Validate() error

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

type ListTeamMembersOutput

type ListTeamMembersOutput struct {

	// The continuation token to use when requesting the next set of results, if
	// there are more results to be returned.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of team member objects for the project.
	//
	// TeamMembers is a required field
	TeamMembers []TeamMember `locationName:"teamMembers" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTeamMembersOutput) String

func (s ListTeamMembersOutput) String() string

String returns the string representation

type ListTeamMembersRequest

type ListTeamMembersRequest struct {
	*aws.Request
	Input *ListTeamMembersInput
	Copy  func(*ListTeamMembersInput) ListTeamMembersRequest
}

ListTeamMembersRequest is the request type for the ListTeamMembers API operation.

func (ListTeamMembersRequest) Send

Send marshals and sends the ListTeamMembers API request.

type ListTeamMembersResponse added in v0.9.0

type ListTeamMembersResponse struct {
	*ListTeamMembersOutput
	// contains filtered or unexported fields
}

ListTeamMembersResponse is the response type for the ListTeamMembers API operation.

func (*ListTeamMembersResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTeamMembersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTeamMembers request.

type ListUserProfilesInput

type ListUserProfilesInput struct {

	// The maximum number of results to return in a response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The continuation token for the next set of results, if the results cannot
	// be returned in one response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListUserProfilesInput) String

func (s ListUserProfilesInput) String() string

String returns the string representation

func (*ListUserProfilesInput) Validate

func (s *ListUserProfilesInput) Validate() error

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

type ListUserProfilesOutput

type ListUserProfilesOutput struct {

	// The continuation token to use when requesting the next set of results, if
	// there are more results to be returned.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// All the user profiles configured in AWS CodeStar for an AWS account.
	//
	// UserProfiles is a required field
	UserProfiles []UserProfileSummary `locationName:"userProfiles" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListUserProfilesOutput) String

func (s ListUserProfilesOutput) String() string

String returns the string representation

type ListUserProfilesRequest

type ListUserProfilesRequest struct {
	*aws.Request
	Input *ListUserProfilesInput
	Copy  func(*ListUserProfilesInput) ListUserProfilesRequest
}

ListUserProfilesRequest is the request type for the ListUserProfiles API operation.

func (ListUserProfilesRequest) Send

Send marshals and sends the ListUserProfiles API request.

type ListUserProfilesResponse added in v0.9.0

type ListUserProfilesResponse struct {
	*ListUserProfilesOutput
	// contains filtered or unexported fields
}

ListUserProfilesResponse is the response type for the ListUserProfiles API operation.

func (*ListUserProfilesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListUserProfilesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListUserProfiles request.

type ProjectStatus added in v0.6.0

type ProjectStatus struct {

	// In the case of a project creation or deletion failure, a reason for the failure.
	Reason *string `locationName:"reason" type:"string"`

	// The phase of completion for a project creation or deletion.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An indication of whether a project creation or deletion is failed or successful.

func (ProjectStatus) String added in v0.6.0

func (s ProjectStatus) String() string

String returns the string representation

type ProjectSummary

type ProjectSummary struct {

	// The Amazon Resource Name (ARN) of the project.
	ProjectArn *string `locationName:"projectArn" type:"string"`

	// The ID of the project.
	ProjectId *string `locationName:"projectId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Information about the metadata for a project.

func (ProjectSummary) String

func (s ProjectSummary) String() string

String returns the string representation

type Resource

type Resource struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a resource for a project.

func (Resource) String

func (s Resource) String() string

String returns the string representation

type S3Location added in v0.6.0

type S3Location struct {

	// The Amazon S3 object key where the source code files provided with the project
	// request are stored.
	BucketKey *string `locationName:"bucketKey" type:"string"`

	// The Amazon S3 bucket name where the source code files provided with the project
	// request are stored.
	BucketName *string `locationName:"bucketName" min:"3" type:"string"`
	// contains filtered or unexported fields
}

The Amazon S3 location where the source code files provided with the project request are stored.

func (S3Location) String added in v0.6.0

func (s S3Location) String() string

String returns the string representation

func (*S3Location) Validate added in v0.6.0

func (s *S3Location) Validate() error

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

type TagProjectInput

type TagProjectInput struct {

	// The ID of the project you want to add a tag to.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// The tags you want to add to the project.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagProjectInput) String

func (s TagProjectInput) String() string

String returns the string representation

func (*TagProjectInput) Validate

func (s *TagProjectInput) Validate() error

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

type TagProjectOutput

type TagProjectOutput struct {

	// The tags for the project.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (TagProjectOutput) String

func (s TagProjectOutput) String() string

String returns the string representation

type TagProjectRequest

type TagProjectRequest struct {
	*aws.Request
	Input *TagProjectInput
	Copy  func(*TagProjectInput) TagProjectRequest
}

TagProjectRequest is the request type for the TagProject API operation.

func (TagProjectRequest) Send

Send marshals and sends the TagProject API request.

type TagProjectResponse added in v0.9.0

type TagProjectResponse struct {
	*TagProjectOutput
	// contains filtered or unexported fields
}

TagProjectResponse is the response type for the TagProject API operation.

func (*TagProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *TagProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagProject request.

type TeamMember

type TeamMember struct {

	// The role assigned to the user in the project. Project roles have different
	// levels of access. For more information, see Working with Teams (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html)
	// in the AWS CodeStar User Guide.
	//
	// ProjectRole is a required field
	ProjectRole *string `locationName:"projectRole" type:"string" required:"true"`

	// Whether the user is allowed to remotely access project resources using an
	// SSH public/private key pair.
	RemoteAccessAllowed *bool `locationName:"remoteAccessAllowed" type:"boolean"`

	// The Amazon Resource Name (ARN) of the user in IAM.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a team member in a project.

func (TeamMember) String

func (s TeamMember) String() string

String returns the string representation

type Toolchain added in v0.6.0

type Toolchain struct {

	// The service role ARN for AWS CodeStar to use for the toolchain template during
	// stack provisioning.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The Amazon S3 location where the toolchain template file provided with the
	// project request is stored. AWS CodeStar retrieves the file during project
	// creation.
	//
	// Source is a required field
	Source *ToolchainSource `locationName:"source" type:"structure" required:"true"`

	// The list of parameter overrides to be passed into the toolchain template
	// during stack provisioning, if any.
	StackParameters map[string]string `locationName:"stackParameters" type:"map"`
	// contains filtered or unexported fields
}

The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.

func (Toolchain) String added in v0.6.0

func (s Toolchain) String() string

String returns the string representation

func (*Toolchain) Validate added in v0.6.0

func (s *Toolchain) Validate() error

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

type ToolchainSource added in v0.6.0

type ToolchainSource struct {

	// The Amazon S3 bucket where the toolchain template file provided with the
	// project request is stored.
	//
	// S3 is a required field
	S3 *S3Location `locationName:"s3" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.

func (ToolchainSource) String added in v0.6.0

func (s ToolchainSource) String() string

String returns the string representation

func (*ToolchainSource) Validate added in v0.6.0

func (s *ToolchainSource) Validate() error

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

type UntagProjectInput

type UntagProjectInput struct {

	// The ID of the project to remove tags from.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// The tags to remove from the project.
	//
	// Tags is a required field
	Tags []string `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagProjectInput) String

func (s UntagProjectInput) String() string

String returns the string representation

func (*UntagProjectInput) Validate

func (s *UntagProjectInput) Validate() error

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

type UntagProjectOutput

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

func (UntagProjectOutput) String

func (s UntagProjectOutput) String() string

String returns the string representation

type UntagProjectRequest

type UntagProjectRequest struct {
	*aws.Request
	Input *UntagProjectInput
	Copy  func(*UntagProjectInput) UntagProjectRequest
}

UntagProjectRequest is the request type for the UntagProject API operation.

func (UntagProjectRequest) Send

Send marshals and sends the UntagProject API request.

type UntagProjectResponse added in v0.9.0

type UntagProjectResponse struct {
	*UntagProjectOutput
	// contains filtered or unexported fields
}

UntagProjectResponse is the response type for the UntagProject API operation.

func (*UntagProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *UntagProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagProject request.

type UpdateProjectInput

type UpdateProjectInput struct {

	// The description of the project, if any.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The ID of the project you want to update.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"2" type:"string" required:"true"`

	// The name of the project you want to update.
	Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateProjectInput) String

func (s UpdateProjectInput) String() string

String returns the string representation

func (*UpdateProjectInput) Validate

func (s *UpdateProjectInput) Validate() error

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

type UpdateProjectOutput

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

func (UpdateProjectOutput) String

func (s UpdateProjectOutput) String() string

String returns the string representation

type UpdateProjectRequest

type UpdateProjectRequest struct {
	*aws.Request
	Input *UpdateProjectInput
	Copy  func(*UpdateProjectInput) UpdateProjectRequest
}

UpdateProjectRequest is the request type for the UpdateProject API operation.

func (UpdateProjectRequest) Send

Send marshals and sends the UpdateProject API request.

type UpdateProjectResponse added in v0.9.0

type UpdateProjectResponse struct {
	*UpdateProjectOutput
	// contains filtered or unexported fields
}

UpdateProjectResponse is the response type for the UpdateProject API operation.

func (*UpdateProjectResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateProject request.

type UpdateTeamMemberInput

type UpdateTeamMemberInput struct {

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"2" type:"string" required:"true"`

	// The role assigned to the user in the project. Project roles have different
	// levels of access. For more information, see Working with Teams (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html)
	// in the AWS CodeStar User Guide.
	ProjectRole *string `locationName:"projectRole" type:"string"`

	// Whether a team member is allowed to remotely access project resources using
	// the SSH public key associated with the user's profile. Even if this is set
	// to True, the user must associate a public key with their profile before the
	// user can access resources.
	RemoteAccessAllowed *bool `locationName:"remoteAccessAllowed" type:"boolean"`

	// The Amazon Resource Name (ARN) of the user for whom you want to change team
	// membership attributes.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTeamMemberInput) String

func (s UpdateTeamMemberInput) String() string

String returns the string representation

func (*UpdateTeamMemberInput) Validate

func (s *UpdateTeamMemberInput) Validate() error

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

type UpdateTeamMemberOutput

type UpdateTeamMemberOutput struct {

	// The project role granted to the user.
	ProjectRole *string `locationName:"projectRole" type:"string"`

	// Whether a team member is allowed to remotely access project resources using
	// the SSH public key associated with the user's profile.
	RemoteAccessAllowed *bool `locationName:"remoteAccessAllowed" type:"boolean"`

	// The Amazon Resource Name (ARN) of the user whose team membership attributes
	// were updated.
	UserArn *string `locationName:"userArn" min:"32" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateTeamMemberOutput) String

func (s UpdateTeamMemberOutput) String() string

String returns the string representation

type UpdateTeamMemberRequest

type UpdateTeamMemberRequest struct {
	*aws.Request
	Input *UpdateTeamMemberInput
	Copy  func(*UpdateTeamMemberInput) UpdateTeamMemberRequest
}

UpdateTeamMemberRequest is the request type for the UpdateTeamMember API operation.

func (UpdateTeamMemberRequest) Send

Send marshals and sends the UpdateTeamMember API request.

type UpdateTeamMemberResponse added in v0.9.0

type UpdateTeamMemberResponse struct {
	*UpdateTeamMemberOutput
	// contains filtered or unexported fields
}

UpdateTeamMemberResponse is the response type for the UpdateTeamMember API operation.

func (*UpdateTeamMemberResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateTeamMemberResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateTeamMember request.

type UpdateUserProfileInput

type UpdateUserProfileInput struct {

	// The name that is displayed as the friendly name for the user in AWS CodeStar.
	DisplayName *string `locationName:"displayName" min:"1" type:"string" sensitive:"true"`

	// The email address that is displayed as part of the user's profile in AWS
	// CodeStar.
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" sensitive:"true"`

	// The SSH public key associated with the user in AWS CodeStar. If a project
	// owner allows the user remote access to project resources, this public key
	// will be used along with the user's private key for SSH access.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The name that will be displayed as the friendly name for the user in AWS
	// CodeStar.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserProfileInput) String

func (s UpdateUserProfileInput) String() string

String returns the string representation

func (*UpdateUserProfileInput) Validate

func (s *UpdateUserProfileInput) Validate() error

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

type UpdateUserProfileOutput

type UpdateUserProfileOutput struct {

	// The date the user profile was created, in timestamp format.
	CreatedTimestamp *time.Time `locationName:"createdTimestamp" type:"timestamp"`

	// The name that is displayed as the friendly name for the user in AWS CodeStar.
	DisplayName *string `locationName:"displayName" min:"1" type:"string" sensitive:"true"`

	// The email address that is displayed as part of the user's profile in AWS
	// CodeStar.
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" sensitive:"true"`

	// The date the user profile was last modified, in timestamp format.
	LastModifiedTimestamp *time.Time `locationName:"lastModifiedTimestamp" type:"timestamp"`

	// The SSH public key associated with the user in AWS CodeStar. This is the
	// public portion of the public/private keypair the user can use to access project
	// resources if a project owner allows the user remote access to those resources.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The Amazon Resource Name (ARN) of the user in IAM.
	//
	// UserArn is a required field
	UserArn *string `locationName:"userArn" min:"32" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserProfileOutput) String

func (s UpdateUserProfileOutput) String() string

String returns the string representation

type UpdateUserProfileRequest

type UpdateUserProfileRequest struct {
	*aws.Request
	Input *UpdateUserProfileInput
	Copy  func(*UpdateUserProfileInput) UpdateUserProfileRequest
}

UpdateUserProfileRequest is the request type for the UpdateUserProfile API operation.

func (UpdateUserProfileRequest) Send

Send marshals and sends the UpdateUserProfile API request.

type UpdateUserProfileResponse added in v0.9.0

type UpdateUserProfileResponse struct {
	*UpdateUserProfileOutput
	// contains filtered or unexported fields
}

UpdateUserProfileResponse is the response type for the UpdateUserProfile API operation.

func (*UpdateUserProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateUserProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUserProfile request.

type UserProfileSummary

type UserProfileSummary struct {

	// The display name of a user in AWS CodeStar. For example, this could be set
	// to both first and last name ("Mary Major") or a single name ("Mary"). The
	// display name is also used to generate the initial icon associated with the
	// user in AWS CodeStar projects. If spaces are included in the display name,
	// the first character that appears after the space will be used as the second
	// character in the user initial icon. The initial icon displays a maximum of
	// two characters, so a display name with more than one space (for example "Mary
	// Jane Major") would generate an initial icon using the first character and
	// the first character after the space ("MJ", not "MM").
	DisplayName *string `locationName:"displayName" min:"1" type:"string" sensitive:"true"`

	// The email address associated with the user.
	EmailAddress *string `locationName:"emailAddress" min:"3" type:"string" sensitive:"true"`

	// The SSH public key associated with the user in AWS CodeStar. If a project
	// owner allows the user remote access to project resources, this public key
	// will be used along with the user's private key for SSH access.
	SshPublicKey *string `locationName:"sshPublicKey" type:"string"`

	// The Amazon Resource Name (ARN) of the user in IAM.
	UserArn *string `locationName:"userArn" min:"32" type:"string"`
	// contains filtered or unexported fields
}

Information about a user's profile in AWS CodeStar.

func (UserProfileSummary) String

func (s UserProfileSummary) String() string

String returns the string representation

Directories

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL