123 lines
4.8 KiB
Go
123 lines
4.8 KiB
Go
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
|
|
|
|
// Package codestar provides the client and types for making API
|
|
// requests to AWS 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 in AWS CodeStar.
|
|
//
|
|
// * DescribeProject, which lists the attributes of a project.
|
|
//
|
|
// * ListProjects, which lists all AWS CodeStar projects associated with
|
|
// your AWS account.
|
|
//
|
|
// * ListResources, which lists the resources associated with an AWS CodeStar
|
|
// project.
|
|
//
|
|
// * UpdateProject, which updates the attributes of an AWS CodeStar project.
|
|
//
|
|
// Teams and team members, by calling the following:
|
|
//
|
|
// * AssociateTeamMember, which adds an IAM user to the team for an AWS CodeStar
|
|
// project.
|
|
//
|
|
// * DisassociateTeamMember, which removes an IAM user from the team for
|
|
// an AWS CodeStar project.
|
|
//
|
|
// * ListTeamMembers, which lists all the IAM users in the team for an AWS
|
|
// CodeStar project, including their roles and attributes.
|
|
//
|
|
// Users, by calling the following:
|
|
//
|
|
// * CreateUserProfile, which creates a user profile that contains data associated
|
|
// with the user across all AWS CodeStar projects.
|
|
//
|
|
// * DeleteUserProfile, which deletes all user profile information across
|
|
// all AWS CodeStar projects.
|
|
//
|
|
// * DescribeUserProfile, which describes the profile of a user.
|
|
//
|
|
// * ListUserProfiles, which lists all AWS CodeStar user profiles.
|
|
//
|
|
// * UpdateUserProfile, which updates the profile for an AWS CodeStar 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 the client for AWS CodeStar you will first need
|
|
// to create a new instance of it.
|
|
//
|
|
// When creating a client for an AWS service you'll first need to have a Session
|
|
// already created. The Session provides configuration that can be shared
|
|
// between multiple service clients. Additional configuration can be applied to
|
|
// the Session and service's client when they are constructed. The aws package's
|
|
// Config type contains several fields such as Region for the AWS Region the
|
|
// client should make API requests too. The optional Config value can be provided
|
|
// as the variadic argument for Sessions and client creation.
|
|
//
|
|
// Once the service's client is created you can use it to make API requests the
|
|
// AWS service. These clients are safe to use concurrently.
|
|
//
|
|
// // Create a session to share configuration, and load external configuration.
|
|
// sess := session.Must(session.NewSession())
|
|
//
|
|
// // Create the service's client with the session.
|
|
// svc := codestar.New(sess)
|
|
//
|
|
// See the SDK's documentation for more information on how to use service clients.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/
|
|
//
|
|
// See aws package's Config type for more information on configuration options.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
|
|
//
|
|
// See the AWS CodeStar client CodeStar for more
|
|
// information on creating the service's client.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/codestar/#New
|
|
//
|
|
// Once the client is created you can make an API request to the service.
|
|
// Each API method takes a input parameter, and returns the service response
|
|
// and an error.
|
|
//
|
|
// The API method will document which error codes the service can be returned
|
|
// by the operation if the service models the API operation's errors. These
|
|
// errors will also be available as const strings prefixed with "ErrCode".
|
|
//
|
|
// result, err := svc.AssociateTeamMember(params)
|
|
// if err != nil {
|
|
// // Cast err to awserr.Error to handle specific error codes.
|
|
// aerr, ok := err.(awserr.Error)
|
|
// if ok && aerr.Code() == <error code to check for> {
|
|
// // Specific error code handling
|
|
// }
|
|
// return err
|
|
// }
|
|
//
|
|
// fmt.Println("AssociateTeamMember result:")
|
|
// fmt.Println(result)
|
|
//
|
|
// Using the Client with Context
|
|
//
|
|
// The service's client also provides methods to make API requests with a Context
|
|
// value. This allows you to control the timeout, and cancellation of pending
|
|
// requests. These methods also take request Option as variadic parameter to apply
|
|
// additional configuration to the API request.
|
|
//
|
|
// ctx := context.Background()
|
|
//
|
|
// result, err := svc.AssociateTeamMemberWithContext(ctx, params)
|
|
//
|
|
// See the request package documentation for more information on using Context pattern
|
|
// with the SDK.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
|
|
package codestar
|