codecatalyst

package module
v1.13.1 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 40 Imported by: 2

Documentation

Overview

Package codecatalyst provides the API client, operations, and parameter types for Amazon CodeCatalyst.

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects. Spaces, by calling the following:

  • DeleteSpace , which deletes a space.
  • GetSpace , which returns information about a space.
  • GetSubscription , which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
  • ListSpaces , which retrieves a list of spaces.
  • UpdateSpace , which changes one or more values for a space.

Projects, by calling the following:

  • CreateProject which creates a project in a specified space.
  • GetProject , which returns information about a project.
  • ListProjects , which retrieves a list of projects in a space.

Users, by calling the following:

  • GetUserDetails , which returns information about a user in Amazon CodeCatalyst.

Source repositories, by calling the following:

  • CreateSourceRepository , which creates an empty Git-based source repository in a specified project.
  • CreateSourceRepositoryBranch , which creates a branch in a specified repository where you can work on code.
  • DeleteSourceRepository , which deletes a source repository.
  • GetSourceRepository , which returns information about a source repository.
  • GetSourceRepositoryCloneUrls , which returns information about the URLs that can be used with a Git client to clone a source repository.
  • ListSourceRepositories , which retrieves a list of source repositories in a project.
  • ListSourceRepositoryBranches , which retrieves a list of branches in a source repository.

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

  • CreateDevEnvironment , which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
  • DeleteDevEnvironment , which deletes a Dev Environment.
  • GetDevEnvironment , which returns information about a Dev Environment.
  • ListDevEnvironments , which retrieves a list of Dev Environments in a project.
  • ListDevEnvironmentSessions , which retrieves a list of active Dev Environment sessions in a project.
  • StartDevEnvironment , which starts a specified Dev Environment and puts it into an active state.
  • StartDevEnvironmentSession , which starts a session to a specified Dev Environment.
  • StopDevEnvironment , which stops a specified Dev Environment and puts it into an stopped state.
  • StopDevEnvironmentSession , which stops a session for a specified Dev Environment.
  • UpdateDevEnvironment , which changes one or more values for a Dev Environment.

Workflows, by calling the following:

  • GetWorkflow , which returns information about a workflow.
  • GetWorkflowRun , which returns information about a specified run of a workflow.
  • ListWorkflowRuns , which retrieves a list of runs of a specified workflow.
  • ListWorkflows , which retrieves a list of workflows in a specified project.
  • StartWorkflowRun , which starts a run of a specified workflow.

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

  • CreateAccessToken , which creates a personal access token (PAT) for the current user.
  • DeleteAccessToken , which deletes a specified personal access token (PAT).
  • ListAccessTokens , which lists all personal access tokens (PATs) associated with a user.
  • ListEventLogs , which retrieves a list of events that occurred during a specified time period in a space.
  • VerifySession , which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO). For more information, see Setting up to use the CLI with Amazon CodeCatalyst (https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html) and the SSO documentation for your SDK.

Index

Constants

View Source
const ServiceAPIVersion = "2022-09-28"
View Source
const ServiceID = "CodeCatalyst"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.5.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

Types

type AuthResolverParameters added in v1.8.0

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.8.0

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

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

Client provides the API client to make operations call for Amazon CodeCatalyst.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateAccessToken

func (c *Client) CreateAccessToken(ctx context.Context, params *CreateAccessTokenInput, optFns ...func(*Options)) (*CreateAccessTokenOutput, error)

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html) .

func (*Client) CreateDevEnvironment

func (c *Client) CreateDevEnvironment(ctx context.Context, params *CreateDevEnvironmentInput, optFns ...func(*Options)) (*CreateDevEnvironmentOutput, error)

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project. When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

func (*Client) CreateProject

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a project in a specified space.

func (*Client) CreateSourceRepository added in v1.4.0

func (c *Client) CreateSourceRepository(ctx context.Context, params *CreateSourceRepositoryInput, optFns ...func(*Options)) (*CreateSourceRepositoryOutput, error)

Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main .

func (*Client) CreateSourceRepositoryBranch

func (c *Client) CreateSourceRepositoryBranch(ctx context.Context, params *CreateSourceRepositoryBranchInput, optFns ...func(*Options)) (*CreateSourceRepositoryBranchOutput, error)

Creates a branch in a specified source repository in Amazon CodeCatalyst. This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

func (*Client) DeleteAccessToken

func (c *Client) DeleteAccessToken(ctx context.Context, params *DeleteAccessTokenInput, optFns ...func(*Options)) (*DeleteAccessTokenOutput, error)

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

func (*Client) DeleteDevEnvironment

func (c *Client) DeleteDevEnvironment(ctx context.Context, params *DeleteDevEnvironmentInput, optFns ...func(*Options)) (*DeleteDevEnvironmentOutput, error)

Deletes a Dev Environment.

func (*Client) DeleteProject added in v1.4.0

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes a project in a space.

func (*Client) DeleteSourceRepository added in v1.4.0

func (c *Client) DeleteSourceRepository(ctx context.Context, params *DeleteSourceRepositoryInput, optFns ...func(*Options)) (*DeleteSourceRepositoryOutput, error)

Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

func (*Client) DeleteSpace added in v1.4.0

func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optFns ...func(*Options)) (*DeleteSpaceOutput, error)

Deletes a space. Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

func (*Client) GetDevEnvironment

func (c *Client) GetDevEnvironment(ctx context.Context, params *GetDevEnvironmentInput, optFns ...func(*Options)) (*GetDevEnvironmentOutput, error)

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

func (*Client) GetProject

func (c *Client) GetProject(ctx context.Context, params *GetProjectInput, optFns ...func(*Options)) (*GetProjectOutput, error)

Returns information about a project.

func (*Client) GetSourceRepository added in v1.4.0

func (c *Client) GetSourceRepository(ctx context.Context, params *GetSourceRepositoryInput, optFns ...func(*Options)) (*GetSourceRepositoryOutput, error)

Returns information about a source repository.

func (*Client) GetSourceRepositoryCloneUrls

func (c *Client) GetSourceRepositoryCloneUrls(ctx context.Context, params *GetSourceRepositoryCloneUrlsInput, optFns ...func(*Options)) (*GetSourceRepositoryCloneUrlsOutput, error)

Returns information about the URLs that can be used with a Git client to clone a source repository.

func (*Client) GetSpace

func (c *Client) GetSpace(ctx context.Context, params *GetSpaceInput, optFns ...func(*Options)) (*GetSpaceOutput, error)

Returns information about an space.

func (*Client) GetSubscription

func (c *Client) GetSubscription(ctx context.Context, params *GetSubscriptionInput, optFns ...func(*Options)) (*GetSubscriptionOutput, error)

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

func (*Client) GetUserDetails

func (c *Client) GetUserDetails(ctx context.Context, params *GetUserDetailsInput, optFns ...func(*Options)) (*GetUserDetailsOutput, error)

Returns information about a user.

func (*Client) GetWorkflow added in v1.8.0

func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error)

Returns information about a workflow.

func (*Client) GetWorkflowRun added in v1.8.0

func (c *Client) GetWorkflowRun(ctx context.Context, params *GetWorkflowRunInput, optFns ...func(*Options)) (*GetWorkflowRunOutput, error)

Returns information about a specified run of a workflow.

func (*Client) ListAccessTokens

func (c *Client) ListAccessTokens(ctx context.Context, params *ListAccessTokensInput, optFns ...func(*Options)) (*ListAccessTokensOutput, error)

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.

func (*Client) ListDevEnvironmentSessions added in v1.3.0

func (c *Client) ListDevEnvironmentSessions(ctx context.Context, params *ListDevEnvironmentSessionsInput, optFns ...func(*Options)) (*ListDevEnvironmentSessionsOutput, error)

Retrieves a list of active sessions for a Dev Environment in a project.

func (*Client) ListDevEnvironments

func (c *Client) ListDevEnvironments(ctx context.Context, params *ListDevEnvironmentsInput, optFns ...func(*Options)) (*ListDevEnvironmentsOutput, error)

Retrieves a list of Dev Environments in a project.

func (*Client) ListEventLogs

func (c *Client) ListEventLogs(ctx context.Context, params *ListEventLogsInput, optFns ...func(*Options)) (*ListEventLogsOutput, error)

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-monitoring.html) in the Amazon CodeCatalyst User Guide. ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) and Working with CloudTrail trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-getting-started.html) .

func (*Client) ListProjects

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Retrieves a list of projects.

func (*Client) ListSourceRepositories

func (c *Client) ListSourceRepositories(ctx context.Context, params *ListSourceRepositoriesInput, optFns ...func(*Options)) (*ListSourceRepositoriesOutput, error)

Retrieves a list of source repositories in a project.

func (*Client) ListSourceRepositoryBranches

func (c *Client) ListSourceRepositoryBranches(ctx context.Context, params *ListSourceRepositoryBranchesInput, optFns ...func(*Options)) (*ListSourceRepositoryBranchesOutput, error)

Retrieves a list of branches in a specified source repository.

func (*Client) ListSpaces

func (c *Client) ListSpaces(ctx context.Context, params *ListSpacesInput, optFns ...func(*Options)) (*ListSpacesOutput, error)

Retrieves a list of spaces.

func (*Client) ListWorkflowRuns added in v1.8.0

func (c *Client) ListWorkflowRuns(ctx context.Context, params *ListWorkflowRunsInput, optFns ...func(*Options)) (*ListWorkflowRunsOutput, error)

Retrieves a list of workflow runs of a specified workflow.

func (*Client) ListWorkflows added in v1.8.0

func (c *Client) ListWorkflows(ctx context.Context, params *ListWorkflowsInput, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

Retrieves a list of workflows in a specified project.

func (*Client) Options added in v1.10.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartDevEnvironment

func (c *Client) StartDevEnvironment(ctx context.Context, params *StartDevEnvironmentInput, optFns ...func(*Options)) (*StartDevEnvironmentOutput, error)

Starts a specified Dev Environment and puts it into an active state.

func (*Client) StartDevEnvironmentSession

func (c *Client) StartDevEnvironmentSession(ctx context.Context, params *StartDevEnvironmentSessionInput, optFns ...func(*Options)) (*StartDevEnvironmentSessionOutput, error)

Starts a session for a specified Dev Environment.

func (*Client) StartWorkflowRun added in v1.8.0

func (c *Client) StartWorkflowRun(ctx context.Context, params *StartWorkflowRunInput, optFns ...func(*Options)) (*StartWorkflowRunOutput, error)

Begins a run of a specified workflow.

func (*Client) StopDevEnvironment

func (c *Client) StopDevEnvironment(ctx context.Context, params *StopDevEnvironmentInput, optFns ...func(*Options)) (*StopDevEnvironmentOutput, error)

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

func (*Client) StopDevEnvironmentSession added in v1.2.0

func (c *Client) StopDevEnvironmentSession(ctx context.Context, params *StopDevEnvironmentSessionInput, optFns ...func(*Options)) (*StopDevEnvironmentSessionOutput, error)

Stops a session for a specified Dev Environment.

func (*Client) UpdateDevEnvironment

func (c *Client) UpdateDevEnvironment(ctx context.Context, params *UpdateDevEnvironmentInput, optFns ...func(*Options)) (*UpdateDevEnvironmentOutput, error)

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

func (*Client) UpdateProject added in v1.4.0

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Changes one or more values for a project.

func (*Client) UpdateSpace added in v1.4.0

func (c *Client) UpdateSpace(ctx context.Context, params *UpdateSpaceInput, optFns ...func(*Options)) (*UpdateSpaceOutput, error)

Changes one or more values for a space.

func (*Client) VerifySession

func (c *Client) VerifySession(ctx context.Context, params *VerifySessionInput, optFns ...func(*Options)) (*VerifySessionOutput, error)

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

type CreateAccessTokenInput

type CreateAccessTokenInput struct {

	// The friendly name of the personal access token.
	//
	// This member is required.
	Name *string

	// The date and time the personal access token expires, in coordinated universal
	// time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	ExpiresTime *time.Time
	// contains filtered or unexported fields
}

type CreateAccessTokenOutput

type CreateAccessTokenOutput struct {

	// The system-generated unique ID of the access token.
	//
	// This member is required.
	AccessTokenId *string

	// The date and time the personal access token expires, in coordinated universal
	// time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// . If not specified, the default is one year from creation.
	//
	// This member is required.
	ExpiresTime *time.Time

	// The friendly name of the personal access token.
	//
	// This member is required.
	Name *string

	// The secret value of the personal access token.
	//
	// This member is required.
	Secret *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDevEnvironmentInput

type CreateDevEnvironmentInput struct {

	// The Amazon EC2 instace type to use for the Dev Environment.
	//
	// This member is required.
	InstanceType types.InstanceType

	// Information about the amount of storage allocated to the Dev Environment. By
	// default, a Dev Environment is configured to have 16GB of persistent storage when
	// created from the Amazon CodeCatalyst console, but there is no default when
	// programmatically creating a Dev Environment. Valid values for persistent storage
	// are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
	//
	// This member is required.
	PersistentStorage *types.PersistentStorageConfiguration

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The user-defined alias for a Dev Environment.
	Alias *string

	// A user-specified idempotency token. Idempotency ensures that an API request
	// completes only once. With an idempotent request, if the original request
	// completes successfully, the subsequent retries return the result from the
	// original successful request and have no additional effect.
	ClientToken *string

	// Information about the integrated development environment (IDE) configured for a
	// Dev Environment. An IDE is required to create a Dev Environment. For Dev
	// Environment creation, this field contains configuration information and must be
	// provided.
	Ides []types.IdeConfiguration

	// The amount of time the Dev Environment will run without any activity detected
	// before stopping, in minutes. Only whole integers are allowed. Dev Environments
	// consume compute minutes when running.
	InactivityTimeoutMinutes int32

	// The source repository that contains the branch to clone into the Dev
	// Environment.
	Repositories []types.RepositoryInput

	// The name of the connection that will be used to connect to Amazon VPC, if any.
	VpcConnectionName *string
	// contains filtered or unexported fields
}

type CreateDevEnvironmentOutput

type CreateDevEnvironmentOutput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The name of the connection used to connect to Amazon VPC used when the Dev
	// Environment was created, if any.
	VpcConnectionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProjectInput

type CreateProjectInput struct {

	// The friendly name of the project that will be displayed to users.
	//
	// This member is required.
	DisplayName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The description of the project. This description will be displayed to all users
	// of the project. We recommend providing a brief description of the project and
	// its intended purpose.
	Description *string
	// contains filtered or unexported fields
}

type CreateProjectOutput

type CreateProjectOutput struct {

	// The name of the project in the space.
	//
	// This member is required.
	Name *string

	// The description of the project.
	Description *string

	// The friendly name of the project.
	DisplayName *string

	// The name of the space.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSourceRepositoryBranchInput

type CreateSourceRepositoryBranchInput struct {

	// The name for the branch you're creating.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the repository where you want to create a branch.
	//
	// This member is required.
	SourceRepositoryName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The commit ID in an existing branch from which you want to create the new
	// branch.
	HeadCommitId *string
	// contains filtered or unexported fields
}

type CreateSourceRepositoryBranchOutput

type CreateSourceRepositoryBranchOutput struct {

	// The commit ID of the tip of the newly created branch.
	HeadCommitId *string

	// The time the branch was last updated, in coordinated universal time (UTC)
	// timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	LastUpdatedTime *time.Time

	// The name of the newly created branch.
	Name *string

	// The Git reference name of the branch.
	Ref *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSourceRepositoryInput added in v1.4.0

type CreateSourceRepositoryInput struct {

	// The name of the source repository. For more information about name
	// requirements, see Quotas for source repositories (https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-quotas.html)
	// .
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The description of the source repository.
	Description *string
	// contains filtered or unexported fields
}

type CreateSourceRepositoryOutput added in v1.4.0

type CreateSourceRepositoryOutput struct {

	// The name of the source repository.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The description of the source repository.
	Description *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccessTokenInput

type DeleteAccessTokenInput struct {

	// The ID of the personal access token to delete. You can find the IDs of all PATs
	// associated with your Amazon Web Services Builder ID in a space by calling
	// ListAccessTokens .
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteAccessTokenOutput

type DeleteAccessTokenOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDevEnvironmentInput

type DeleteDevEnvironmentInput struct {

	// The system-generated unique ID of the Dev Environment you want to delete. To
	// retrieve a list of Dev Environment IDs, use ListDevEnvironments .
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type DeleteDevEnvironmentOutput

type DeleteDevEnvironmentOutput struct {

	// The system-generated unique ID of the deleted Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProjectInput added in v1.4.0

type DeleteProjectInput struct {

	// The name of the project in the space. To retrieve a list of project names, use
	// ListProjects .
	//
	// This member is required.
	Name *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type DeleteProjectOutput added in v1.4.0

type DeleteProjectOutput struct {

	// The name of the project in the space.
	//
	// This member is required.
	Name *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The friendly name displayed to users of the project in Amazon CodeCatalyst.
	DisplayName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSourceRepositoryInput added in v1.4.0

type DeleteSourceRepositoryInput struct {

	// The name of the source repository.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type DeleteSourceRepositoryOutput added in v1.4.0

type DeleteSourceRepositoryOutput struct {

	// The name of the repository.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSpaceInput added in v1.4.0

type DeleteSpaceInput struct {

	// The name of the space. To retrieve a list of space names, use ListSpaces .
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteSpaceOutput added in v1.4.0

type DeleteSpaceOutput struct {

	// The name of the space.
	//
	// This member is required.
	Name *string

	// The friendly name of the space displayed to users of the space in Amazon
	// CodeCatalyst.
	DisplayName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.5.0

type EndpointParameters struct {
	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.5.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.5.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.5.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.5.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDevEnvironmentInput

type GetDevEnvironmentInput struct {

	// The system-generated unique ID of the Dev Environment for which you want to
	// view information. To retrieve a list of Dev Environment IDs, use
	// ListDevEnvironments .
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetDevEnvironmentOutput

type GetDevEnvironmentOutput struct {

	// The system-generated unique ID of the user who created the Dev Environment.
	//
	// This member is required.
	CreatorId *string

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The amount of time the Dev Environment will run without any activity detected
	// before stopping, in minutes.
	//
	// This member is required.
	InactivityTimeoutMinutes int32

	// The Amazon EC2 instace type to use for the Dev Environment.
	//
	// This member is required.
	InstanceType types.InstanceType

	// The time when the Dev Environment was last updated, in coordinated universal
	// time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// Information about the amount of storage allocated to the Dev Environment. By
	// default, a Dev Environment is configured to have 16GB of persistent storage.
	//
	// This member is required.
	PersistentStorage *types.PersistentStorage

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The source repository that contains the branch cloned into the Dev Environment.
	//
	// This member is required.
	Repositories []types.DevEnvironmentRepositorySummary

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The current status of the Dev Environment.
	//
	// This member is required.
	Status types.DevEnvironmentStatus

	// The user-specified alias for the Dev Environment.
	Alias *string

	// Information about the integrated development environment (IDE) configured for
	// the Dev Environment.
	Ides []types.Ide

	// The reason for the status.
	StatusReason *string

	// The name of the connection used to connect to Amazon VPC used when the Dev
	// Environment was created, if any.
	VpcConnectionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProjectInput

type GetProjectInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	Name *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetProjectOutput

type GetProjectOutput struct {

	// The name of the project in the space.
	//
	// This member is required.
	Name *string

	// The description of the project.
	Description *string

	// The friendly name of the project displayed to users in Amazon CodeCatalyst.
	DisplayName *string

	// The name of the space.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSourceRepositoryCloneUrlsInput

type GetSourceRepositoryCloneUrlsInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the source repository.
	//
	// This member is required.
	SourceRepositoryName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetSourceRepositoryCloneUrlsOutput

type GetSourceRepositoryCloneUrlsOutput struct {

	// The HTTPS URL to use when cloning the source repository.
	//
	// This member is required.
	Https *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSourceRepositoryInput added in v1.4.0

type GetSourceRepositoryInput struct {

	// The name of the source repository.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetSourceRepositoryOutput added in v1.4.0

type GetSourceRepositoryOutput struct {

	// The time the source repository was created, in coordinated universal time (UTC)
	// timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	//
	// This member is required.
	CreatedTime *time.Time

	// The time the source repository was last updated, in coordinated universal time
	// (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The name of the source repository.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The description of the source repository.
	Description *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSpaceInput

type GetSpaceInput struct {

	// The name of the space.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetSpaceOutput

type GetSpaceOutput struct {

	// The name of the space.
	//
	// This member is required.
	Name *string

	// The Amazon Web Services Region where the space exists.
	//
	// This member is required.
	RegionName *string

	// The description of the space.
	Description *string

	// The friendly name of the space displayed to users.
	DisplayName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSubscriptionInput

type GetSubscriptionInput struct {

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetSubscriptionOutput

type GetSubscriptionOutput struct {

	// The display name of the Amazon Web Services account used for billing for the
	// space.
	AwsAccountName *string

	// The day and time the pending change will be applied to the space, in
	// coordinated universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	PendingSubscriptionStartTime *time.Time

	// The type of the billing plan that the space will be changed to at the start of
	// the next billing cycle. This applies only to changes that reduce the
	// functionality available for the space. Billing plan changes that increase
	// functionality are applied immediately. For more information, see Pricing (https://codecatalyst.aws/explore/pricing)
	// .
	PendingSubscriptionType *string

	// The type of the billing plan for the space.
	SubscriptionType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetUserDetailsInput

type GetUserDetailsInput struct {

	// The system-generated unique ID of the user.
	Id *string

	// The name of the user as displayed in Amazon CodeCatalyst.
	UserName *string
	// contains filtered or unexported fields
}

type GetUserDetailsOutput

type GetUserDetailsOutput struct {

	// The friendly name displayed for the user in Amazon CodeCatalyst.
	DisplayName *string

	// The email address provided by the user when they signed up.
	PrimaryEmail *types.EmailAddress

	// The system-generated unique ID of the user.
	UserId *string

	// The name of the user as displayed in Amazon CodeCatalyst.
	UserName *string

	//
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowInput added in v1.8.0

type GetWorkflowInput struct {

	// The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows .
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetWorkflowOutput added in v1.8.0

type GetWorkflowOutput struct {

	// The date and time the workflow was created, in coordinated universal time (UTC)
	// timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	//
	// This member is required.
	CreatedTime *time.Time

	// Information about the workflow definition file for the workflow.
	//
	// This member is required.
	Definition *types.WorkflowDefinition

	// The ID of the workflow.
	//
	// This member is required.
	Id *string

	// The date and time the workflow was last updated, in coordinated universal time
	// (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The name of the workflow.
	//
	// This member is required.
	Name *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The behavior to use when multiple workflows occur at the same time. For more
	// information, see
	// https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html (https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html)
	// in the Amazon CodeCatalyst User Guide.
	//
	// This member is required.
	RunMode types.WorkflowRunMode

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The status of the workflow.
	//
	// This member is required.
	Status types.WorkflowStatus

	// The name of the branch that contains the workflow YAML.
	SourceBranchName *string

	// The name of the source repository where the workflow YAML is stored.
	SourceRepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowRunInput added in v1.8.0

type GetWorkflowRunInput struct {

	// The ID of the workflow run. To retrieve a list of workflow run IDs, use
	// ListWorkflowRuns .
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type GetWorkflowRunOutput added in v1.8.0

type GetWorkflowRunOutput struct {

	// The ID of the workflow run.
	//
	// This member is required.
	Id *string

	// The date and time the workflow run status was last updated, in coordinated
	// universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The date and time the workflow run began, in coordinated universal time (UTC)
	// timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	//
	// This member is required.
	StartTime *time.Time

	// The status of the workflow run.
	//
	// This member is required.
	Status types.WorkflowRunStatus

	// The ID of the workflow.
	//
	// This member is required.
	WorkflowId *string

	// The date and time the workflow run ended, in coordinated universal time (UTC)
	// timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	EndTime *time.Time

	// Information about the reasons for the status of the workflow run.
	StatusReasons []types.WorkflowRunStatusReason

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type IdempotencyTokenProvider added in v1.8.0

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccessTokensAPIClient

type ListAccessTokensAPIClient interface {
	ListAccessTokens(context.Context, *ListAccessTokensInput, ...func(*Options)) (*ListAccessTokensOutput, error)
}

ListAccessTokensAPIClient is a client that implements the ListAccessTokens operation.

type ListAccessTokensInput

type ListAccessTokensInput struct {

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAccessTokensOutput

type ListAccessTokensOutput struct {

	// A list of personal access tokens (PATs) associated with the calling user
	// identity.
	//
	// This member is required.
	Items []types.AccessTokenSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccessTokensPaginator

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

ListAccessTokensPaginator is a paginator for ListAccessTokens

func NewListAccessTokensPaginator

func NewListAccessTokensPaginator(client ListAccessTokensAPIClient, params *ListAccessTokensInput, optFns ...func(*ListAccessTokensPaginatorOptions)) *ListAccessTokensPaginator

NewListAccessTokensPaginator returns a new ListAccessTokensPaginator

func (*ListAccessTokensPaginator) HasMorePages

func (p *ListAccessTokensPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccessTokensPaginator) NextPage

func (p *ListAccessTokensPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessTokensOutput, error)

NextPage retrieves the next ListAccessTokens page.

type ListAccessTokensPaginatorOptions

type ListAccessTokensPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccessTokensPaginatorOptions is the paginator options for ListAccessTokens

type ListDevEnvironmentSessionsAPIClient added in v1.3.0

type ListDevEnvironmentSessionsAPIClient interface {
	ListDevEnvironmentSessions(context.Context, *ListDevEnvironmentSessionsInput, ...func(*Options)) (*ListDevEnvironmentSessionsOutput, error)
}

ListDevEnvironmentSessionsAPIClient is a client that implements the ListDevEnvironmentSessions operation.

type ListDevEnvironmentSessionsInput added in v1.3.0

type ListDevEnvironmentSessionsInput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	DevEnvironmentId *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDevEnvironmentSessionsOutput added in v1.3.0

type ListDevEnvironmentSessionsOutput struct {

	// Information about each session retrieved in the list.
	//
	// This member is required.
	Items []types.DevEnvironmentSessionSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDevEnvironmentSessionsPaginator added in v1.3.0

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

ListDevEnvironmentSessionsPaginator is a paginator for ListDevEnvironmentSessions

func NewListDevEnvironmentSessionsPaginator added in v1.3.0

NewListDevEnvironmentSessionsPaginator returns a new ListDevEnvironmentSessionsPaginator

func (*ListDevEnvironmentSessionsPaginator) HasMorePages added in v1.3.0

func (p *ListDevEnvironmentSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevEnvironmentSessionsPaginator) NextPage added in v1.3.0

NextPage retrieves the next ListDevEnvironmentSessions page.

type ListDevEnvironmentSessionsPaginatorOptions added in v1.3.0

type ListDevEnvironmentSessionsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevEnvironmentSessionsPaginatorOptions is the paginator options for ListDevEnvironmentSessions

type ListDevEnvironmentsAPIClient

type ListDevEnvironmentsAPIClient interface {
	ListDevEnvironments(context.Context, *ListDevEnvironmentsInput, ...func(*Options)) (*ListDevEnvironmentsOutput, error)
}

ListDevEnvironmentsAPIClient is a client that implements the ListDevEnvironments operation.

type ListDevEnvironmentsInput

type ListDevEnvironmentsInput struct {

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Information about filters to apply to narrow the results returned in the list.
	Filters []types.Filter

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// The name of the project in the space.
	ProjectName *string
	// contains filtered or unexported fields
}

type ListDevEnvironmentsOutput

type ListDevEnvironmentsOutput struct {

	// Information about the Dev Environments in a project.
	//
	// This member is required.
	Items []types.DevEnvironmentSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDevEnvironmentsPaginator

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

ListDevEnvironmentsPaginator is a paginator for ListDevEnvironments

func NewListDevEnvironmentsPaginator

func NewListDevEnvironmentsPaginator(client ListDevEnvironmentsAPIClient, params *ListDevEnvironmentsInput, optFns ...func(*ListDevEnvironmentsPaginatorOptions)) *ListDevEnvironmentsPaginator

NewListDevEnvironmentsPaginator returns a new ListDevEnvironmentsPaginator

func (*ListDevEnvironmentsPaginator) HasMorePages

func (p *ListDevEnvironmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevEnvironmentsPaginator) NextPage

func (p *ListDevEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevEnvironmentsOutput, error)

NextPage retrieves the next ListDevEnvironments page.

type ListDevEnvironmentsPaginatorOptions

type ListDevEnvironmentsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevEnvironmentsPaginatorOptions is the paginator options for ListDevEnvironments

type ListEventLogsAPIClient

type ListEventLogsAPIClient interface {
	ListEventLogs(context.Context, *ListEventLogsInput, ...func(*Options)) (*ListEventLogsOutput, error)
}

ListEventLogsAPIClient is a client that implements the ListEventLogs operation.

type ListEventLogsInput

type ListEventLogsInput struct {

	// The time after which you do not want any events retrieved, in coordinated
	// universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	//
	// This member is required.
	EndTime *time.Time

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The date and time when you want to start retrieving events, in coordinated
	// universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6)
	// .
	//
	// This member is required.
	StartTime *time.Time

	// The name of the event.
	EventName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEventLogsOutput

type ListEventLogsOutput struct {

	// Information about each event retrieved in the list.
	//
	// This member is required.
	Items []types.EventLogEntry

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEventLogsPaginator

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

ListEventLogsPaginator is a paginator for ListEventLogs

func NewListEventLogsPaginator

func NewListEventLogsPaginator(client ListEventLogsAPIClient, params *ListEventLogsInput, optFns ...func(*ListEventLogsPaginatorOptions)) *ListEventLogsPaginator

NewListEventLogsPaginator returns a new ListEventLogsPaginator

func (*ListEventLogsPaginator) HasMorePages

func (p *ListEventLogsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventLogsPaginator) NextPage

func (p *ListEventLogsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventLogsOutput, error)

NextPage retrieves the next ListEventLogs page.

type ListEventLogsPaginatorOptions

type ListEventLogsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEventLogsPaginatorOptions is the paginator options for ListEventLogs

type ListProjectsAPIClient

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput

type ListProjectsInput struct {

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Information about filters to apply to narrow the results returned in the list.
	Filters []types.ProjectListFilter

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProjectsOutput

type ListProjectsOutput struct {

	// Information about the projects.
	Items []types.ProjectSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProjectsPaginator

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions

type ListProjectsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListSourceRepositoriesAPIClient

type ListSourceRepositoriesAPIClient interface {
	ListSourceRepositories(context.Context, *ListSourceRepositoriesInput, ...func(*Options)) (*ListSourceRepositoriesOutput, error)
}

ListSourceRepositoriesAPIClient is a client that implements the ListSourceRepositories operation.

type ListSourceRepositoriesInput

type ListSourceRepositoriesInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSourceRepositoriesOutput

type ListSourceRepositoriesOutput struct {

	// Information about the source repositories.
	Items []types.ListSourceRepositoriesItem

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSourceRepositoriesPaginator

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

ListSourceRepositoriesPaginator is a paginator for ListSourceRepositories

func NewListSourceRepositoriesPaginator

NewListSourceRepositoriesPaginator returns a new ListSourceRepositoriesPaginator

func (*ListSourceRepositoriesPaginator) HasMorePages

func (p *ListSourceRepositoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSourceRepositoriesPaginator) NextPage

NextPage retrieves the next ListSourceRepositories page.

type ListSourceRepositoriesPaginatorOptions

type ListSourceRepositoriesPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSourceRepositoriesPaginatorOptions is the paginator options for ListSourceRepositories

type ListSourceRepositoryBranchesAPIClient

type ListSourceRepositoryBranchesAPIClient interface {
	ListSourceRepositoryBranches(context.Context, *ListSourceRepositoryBranchesInput, ...func(*Options)) (*ListSourceRepositoryBranchesOutput, error)
}

ListSourceRepositoryBranchesAPIClient is a client that implements the ListSourceRepositoryBranches operation.

type ListSourceRepositoryBranchesInput

type ListSourceRepositoryBranchesInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the source repository.
	//
	// This member is required.
	SourceRepositoryName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSourceRepositoryBranchesOutput

type ListSourceRepositoryBranchesOutput struct {

	// Information about the source branches.
	//
	// This member is required.
	Items []types.ListSourceRepositoryBranchesItem

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSourceRepositoryBranchesPaginator

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

ListSourceRepositoryBranchesPaginator is a paginator for ListSourceRepositoryBranches

func NewListSourceRepositoryBranchesPaginator

NewListSourceRepositoryBranchesPaginator returns a new ListSourceRepositoryBranchesPaginator

func (*ListSourceRepositoryBranchesPaginator) HasMorePages

func (p *ListSourceRepositoryBranchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSourceRepositoryBranchesPaginator) NextPage

NextPage retrieves the next ListSourceRepositoryBranches page.

type ListSourceRepositoryBranchesPaginatorOptions

type ListSourceRepositoryBranchesPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSourceRepositoryBranchesPaginatorOptions is the paginator options for ListSourceRepositoryBranches

type ListSpacesAPIClient

type ListSpacesAPIClient interface {
	ListSpaces(context.Context, *ListSpacesInput, ...func(*Options)) (*ListSpacesOutput, error)
}

ListSpacesAPIClient is a client that implements the ListSpaces operation.

type ListSpacesInput

type ListSpacesInput struct {

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSpacesOutput

type ListSpacesOutput struct {

	// Information about the spaces.
	Items []types.SpaceSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSpacesPaginator

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

ListSpacesPaginator is a paginator for ListSpaces

func NewListSpacesPaginator

func NewListSpacesPaginator(client ListSpacesAPIClient, params *ListSpacesInput, optFns ...func(*ListSpacesPaginatorOptions)) *ListSpacesPaginator

NewListSpacesPaginator returns a new ListSpacesPaginator

func (*ListSpacesPaginator) HasMorePages

func (p *ListSpacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSpacesPaginator) NextPage

func (p *ListSpacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSpacesOutput, error)

NextPage retrieves the next ListSpaces page.

type ListSpacesPaginatorOptions

type ListSpacesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSpacesPaginatorOptions is the paginator options for ListSpaces

type ListWorkflowRunsAPIClient added in v1.8.0

type ListWorkflowRunsAPIClient interface {
	ListWorkflowRuns(context.Context, *ListWorkflowRunsInput, ...func(*Options)) (*ListWorkflowRunsOutput, error)
}

ListWorkflowRunsAPIClient is a client that implements the ListWorkflowRuns operation.

type ListWorkflowRunsInput added in v1.8.0

type ListWorkflowRunsInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Information used to sort the items in the returned list.
	SortBy []types.WorkflowRunSortCriteria

	// The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows .
	WorkflowId *string
	// contains filtered or unexported fields
}

type ListWorkflowRunsOutput added in v1.8.0

type ListWorkflowRunsOutput struct {

	// Information about the runs of a workflow.
	Items []types.WorkflowRunSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowRunsPaginator added in v1.8.0

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

ListWorkflowRunsPaginator is a paginator for ListWorkflowRuns

func NewListWorkflowRunsPaginator added in v1.8.0

func NewListWorkflowRunsPaginator(client ListWorkflowRunsAPIClient, params *ListWorkflowRunsInput, optFns ...func(*ListWorkflowRunsPaginatorOptions)) *ListWorkflowRunsPaginator

NewListWorkflowRunsPaginator returns a new ListWorkflowRunsPaginator

func (*ListWorkflowRunsPaginator) HasMorePages added in v1.8.0

func (p *ListWorkflowRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowRunsPaginator) NextPage added in v1.8.0

func (p *ListWorkflowRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowRunsOutput, error)

NextPage retrieves the next ListWorkflowRuns page.

type ListWorkflowRunsPaginatorOptions added in v1.8.0

type ListWorkflowRunsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowRunsPaginatorOptions is the paginator options for ListWorkflowRuns

type ListWorkflowsAPIClient added in v1.8.0

type ListWorkflowsAPIClient interface {
	ListWorkflows(context.Context, *ListWorkflowsInput, ...func(*Options)) (*ListWorkflowsOutput, error)
}

ListWorkflowsAPIClient is a client that implements the ListWorkflows operation.

type ListWorkflowsInput added in v1.8.0

type ListWorkflowsInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	MaxResults *int32

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Information used to sort the items in the returned list.
	SortBy []types.WorkflowSortCriteria
	// contains filtered or unexported fields
}

type ListWorkflowsOutput added in v1.8.0

type ListWorkflowsOutput struct {

	// Information about the workflows in a project.
	Items []types.WorkflowSummary

	// A token returned from a call to this API to indicate the next batch of results
	// to return, if any.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowsPaginator added in v1.8.0

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

ListWorkflowsPaginator is a paginator for ListWorkflows

func NewListWorkflowsPaginator added in v1.8.0

func NewListWorkflowsPaginator(client ListWorkflowsAPIClient, params *ListWorkflowsInput, optFns ...func(*ListWorkflowsPaginatorOptions)) *ListWorkflowsPaginator

NewListWorkflowsPaginator returns a new ListWorkflowsPaginator

func (*ListWorkflowsPaginator) HasMorePages added in v1.8.0

func (p *ListWorkflowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowsPaginator) NextPage added in v1.8.0

func (p *ListWorkflowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

NextPage retrieves the next ListWorkflows page.

type ListWorkflowsPaginatorOptions added in v1.8.0

type ListWorkflowsPaginatorOptions struct {
	// The maximum number of results to show in a single call to this API. If the
	// number of results is larger than the number you specified, the response will
	// include a NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowsPaginatorOptions is the paginator options for ListWorkflows

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Signer for authenticating requests with bearer auth
	BearerAuthSigner bearer.Signer

	// Bearer token value provider
	BearerAuthTokenProvider bearer.TokenProvider

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.8.0

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartDevEnvironmentInput

type StartDevEnvironmentInput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Information about the integrated development environment (IDE) configured for a
	// Dev Environment.
	Ides []types.IdeConfiguration

	// The amount of time the Dev Environment will run without any activity detected
	// before stopping, in minutes. Only whole integers are allowed. Dev Environments
	// consume compute minutes when running.
	InactivityTimeoutMinutes int32

	// The Amazon EC2 instace type to use for the Dev Environment.
	InstanceType types.InstanceType
	// contains filtered or unexported fields
}

type StartDevEnvironmentOutput

type StartDevEnvironmentOutput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The status of the Dev Environment.
	//
	// This member is required.
	Status types.DevEnvironmentStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartDevEnvironmentSessionInput

type StartDevEnvironmentSessionInput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// Information about the configuration of a Dev Environment session.
	//
	// This member is required.
	SessionConfiguration *types.DevEnvironmentSessionConfiguration

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type StartDevEnvironmentSessionOutput

type StartDevEnvironmentSessionOutput struct {

	// Information about connection details for a Dev Environment.
	//
	// This member is required.
	AccessDetails *types.DevEnvironmentAccessDetails

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The system-generated unique ID of the Dev Environment session.
	SessionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartWorkflowRunInput added in v1.8.0

type StartWorkflowRunInput struct {

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The system-generated unique ID of the workflow. To retrieve a list of workflow
	// IDs, use ListWorkflows .
	//
	// This member is required.
	WorkflowId *string

	// A user-specified idempotency token. Idempotency ensures that an API request
	// completes only once. With an idempotent request, if the original request
	// completes successfully, the subsequent retries return the result from the
	// original successful request and have no additional effect.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartWorkflowRunOutput added in v1.8.0

type StartWorkflowRunOutput struct {

	// The system-generated unique ID of the workflow run.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The system-generated unique ID of the workflow.
	//
	// This member is required.
	WorkflowId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopDevEnvironmentInput

type StopDevEnvironmentInput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type StopDevEnvironmentOutput

type StopDevEnvironmentOutput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The status of the Dev Environment.
	//
	// This member is required.
	Status types.DevEnvironmentStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopDevEnvironmentSessionInput added in v1.2.0

type StopDevEnvironmentSessionInput struct {

	// The system-generated unique ID of the Dev Environment. To obtain this ID, use
	// ListDevEnvironments .
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The system-generated unique ID of the Dev Environment session. This ID is
	// returned by StartDevEnvironmentSession .
	//
	// This member is required.
	SessionId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type StopDevEnvironmentSessionOutput added in v1.2.0

type StopDevEnvironmentSessionOutput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The system-generated unique ID of the Dev Environment session.
	//
	// This member is required.
	SessionId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDevEnvironmentInput

type UpdateDevEnvironmentInput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The user-specified alias for the Dev Environment. Changing this value will not
	// cause a restart.
	Alias *string

	// A user-specified idempotency token. Idempotency ensures that an API request
	// completes only once. With an idempotent request, if the original request
	// completes successfully, the subsequent retries return the result from the
	// original successful request and have no additional effect.
	ClientToken *string

	// Information about the integrated development environment (IDE) configured for a
	// Dev Environment.
	Ides []types.IdeConfiguration

	// The amount of time the Dev Environment will run without any activity detected
	// before stopping, in minutes. Only whole integers are allowed. Dev Environments
	// consume compute minutes when running. Changing this value will cause a restart
	// of the Dev Environment if it is running.
	InactivityTimeoutMinutes int32

	// The Amazon EC2 instace type to use for the Dev Environment. Changing this value
	// will cause a restart of the Dev Environment if it is running.
	InstanceType types.InstanceType
	// contains filtered or unexported fields
}

type UpdateDevEnvironmentOutput

type UpdateDevEnvironmentOutput struct {

	// The system-generated unique ID of the Dev Environment.
	//
	// This member is required.
	Id *string

	// The name of the project in the space.
	//
	// This member is required.
	ProjectName *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The user-specified alias for the Dev Environment.
	Alias *string

	// A user-specified idempotency token. Idempotency ensures that an API request
	// completes only once. With an idempotent request, if the original request
	// completes successfully, the subsequent retries return the result from the
	// original successful request and have no additional effect.
	ClientToken *string

	// Information about the integrated development environment (IDE) configured for
	// the Dev Environment.
	Ides []types.IdeConfiguration

	// The amount of time the Dev Environment will run without any activity detected
	// before stopping, in minutes.
	InactivityTimeoutMinutes int32

	// The Amazon EC2 instace type to use for the Dev Environment.
	InstanceType types.InstanceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProjectInput added in v1.4.0

type UpdateProjectInput struct {

	// The name of the project.
	//
	// This member is required.
	Name *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The description of the project.
	Description *string
	// contains filtered or unexported fields
}

type UpdateProjectOutput added in v1.4.0

type UpdateProjectOutput struct {

	// The description of the project.
	Description *string

	// The friendly name of the project displayed to users in Amazon CodeCatalyst.
	DisplayName *string

	// The name of the project.
	Name *string

	// The name of the space.
	SpaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSpaceInput added in v1.4.0

type UpdateSpaceInput struct {

	// The name of the space.
	//
	// This member is required.
	Name *string

	// The description of the space.
	Description *string
	// contains filtered or unexported fields
}

type UpdateSpaceOutput added in v1.4.0

type UpdateSpaceOutput struct {

	// The description of the space.
	Description *string

	// The friendly name of the space displayed to users in Amazon CodeCatalyst.
	DisplayName *string

	// The name of the space.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type VerifySessionInput

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

type VerifySessionOutput

type VerifySessionOutput struct {

	// The system-generated unique ID of the user in Amazon CodeCatalyst.
	Identity *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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