types

package
v1.29.8 Latest Latest
Warning

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

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There isn't sufficient access for performing this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccountSettings 

type AccountSettings struct {

	// The Amazon Resource Name (ARN) of the service role that Proton uses for
	// provisioning pipelines. Proton assumes this role for CodeBuild-based
	// provisioning.
	PipelineCodebuildRoleArn *string

	// The linked repository for pipeline provisioning. Required if you have
	// environments configured for self-managed provisioning with services that include
	// pipelines. A linked repository is a repository that has been registered with
	// Proton. For more information, see CreateRepository.
	PipelineProvisioningRepository *RepositoryBranch

	// The Amazon Resource Name (ARN) of the service role you want to use for
	// provisioning pipelines. Assumed by Proton for Amazon Web Services-managed
	// provisioning, and by customer-owned automation for self-managed provisioning.
	PipelineServiceRoleArn *string
	// contains filtered or unexported fields
}

Proton settings that are used for multiple services in the Amazon Web Services account.

type BlockerStatus added in v1.21.0 

type BlockerStatus string
const (
	BlockerStatusActive   BlockerStatus = "ACTIVE"
	BlockerStatusResolved BlockerStatus = "RESOLVED"
)

Enum values for BlockerStatus

func (BlockerStatus) Values added in v1.21.0 

func (BlockerStatus) Values() []BlockerStatus

Values returns all known values for BlockerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BlockerType added in v1.21.0 

type BlockerType string
const (
	BlockerTypeAutomated BlockerType = "AUTOMATED"
)

Enum values for BlockerType

func (BlockerType) Values added in v1.21.0 

func (BlockerType) Values() []BlockerType

Values returns all known values for BlockerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CompatibleEnvironmentTemplate 

type CompatibleEnvironmentTemplate struct {

	// The major version of the compatible environment template.
	//
	// This member is required.
	MajorVersion *string

	// The compatible environment template name.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Compatible environment template data.

type CompatibleEnvironmentTemplateInput 

type CompatibleEnvironmentTemplateInput struct {

	// The major version of the compatible environment template.
	//
	// This member is required.
	MajorVersion *string

	// The compatible environment template name.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Compatible environment template data.

type Component added in v1.14.0 

type Component struct {

	// The Amazon Resource Name (ARN) of the component.
	//
	// This member is required.
	Arn *string

	// The time when the component was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The component deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the Proton environment that this component is associated with.
	//
	// This member is required.
	EnvironmentName *string

	// The time when the component was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// The message associated with the component deployment status.
	DeploymentStatusMessage *string

	// A description of the component.
	Description *string

	// The ID of the last attempted deployment of this component.
	LastAttemptedDeploymentId *string

	// The last token the client requested.
	LastClientRequestToken *string

	// The time when a deployment of the component was last attempted.
	LastDeploymentAttemptedAt *time.Time

	// The time when the component was last deployed successfully.
	LastDeploymentSucceededAt *time.Time

	// The ID of the last successful deployment of this component.
	LastSucceededDeploymentId *string

	// The name of the service instance that this component is attached to. Provided
	// when a component is attached to a service instance.
	ServiceInstanceName *string

	// The name of the service that serviceInstanceName is associated with. Provided
	// when a component is attached to a service instance.
	ServiceName *string

	// The service spec that the component uses to access service inputs. Provided
	// when a component is attached to a service instance.
	//
	// This value conforms to the media type: application/yaml
	ServiceSpec *string
	// contains filtered or unexported fields
}

Detailed data of an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

type ComponentDeploymentUpdateType added in v1.14.0 

type ComponentDeploymentUpdateType string
const (
	ComponentDeploymentUpdateTypeNone           ComponentDeploymentUpdateType = "NONE"
	ComponentDeploymentUpdateTypeCurrentVersion ComponentDeploymentUpdateType = "CURRENT_VERSION"
)

Enum values for ComponentDeploymentUpdateType

func (ComponentDeploymentUpdateType) Values added in v1.14.0 

func (ComponentDeploymentUpdateType) Values() []ComponentDeploymentUpdateType

Values returns all known values for ComponentDeploymentUpdateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComponentState added in v1.22.0 

type ComponentState struct {

	// The name of the service instance that this component is attached to. Provided
	// when a component is attached to a service instance.
	ServiceInstanceName *string

	// The name of the service that serviceInstanceName is associated with. Provided
	// when a component is attached to a service instance.
	ServiceName *string

	// The service spec that the component uses to access service inputs. Provided
	// when a component is attached to a service instance.
	//
	// This value conforms to the media type: application/yaml
	ServiceSpec *string

	// The template file used.
	//
	// This value conforms to the media type: application/yaml
	TemplateFile *string
	// contains filtered or unexported fields
}

The detailed data about the current state of the component.

type ComponentSummary added in v1.14.0 

type ComponentSummary struct {

	// The Amazon Resource Name (ARN) of the component.
	//
	// This member is required.
	Arn *string

	// The time when the component was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The component deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the Proton environment that this component is associated with.
	//
	// This member is required.
	EnvironmentName *string

	// The time when the component was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// The message associated with the component deployment status.
	DeploymentStatusMessage *string

	// The ID of the last attempted deployment of this component.
	LastAttemptedDeploymentId *string

	// The time when a deployment of the component was last attempted.
	LastDeploymentAttemptedAt *time.Time

	// The time when the component was last deployed successfully.
	LastDeploymentSucceededAt *time.Time

	// The ID of the last successful deployment of this component.
	LastSucceededDeploymentId *string

	// The name of the service instance that this component is attached to. Provided
	// when a component is attached to a service instance.
	ServiceInstanceName *string

	// The name of the service that serviceInstanceName is associated with. Provided
	// when a component is attached to a service instance.
	ServiceName *string
	// contains filtered or unexported fields
}

Summary data of an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request couldn't be made due to a conflicting operation or resource.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type CountsSummary added in v1.20.0 

type CountsSummary struct {

	// The total number of components in the Amazon Web Services account.
	//
	// The semantics of the components field are different from the semantics of
	// results for other infrastructure-provisioning resources. That's because at this
	// time components don't have associated templates, therefore they don't have the
	// concept of staleness. The components object will only contain total and failed
	// members.
	Components *ResourceCountsSummary

	// The total number of environment templates in the Amazon Web Services account.
	// The environmentTemplates object will only contain total members.
	EnvironmentTemplates *ResourceCountsSummary

	// The staleness counts for Proton environments in the Amazon Web Services
	// account. The environments object will only contain total members.
	Environments *ResourceCountsSummary

	// The staleness counts for Proton pipelines in the Amazon Web Services account.
	Pipelines *ResourceCountsSummary

	// The staleness counts for Proton service instances in the Amazon Web Services
	// account.
	ServiceInstances *ResourceCountsSummary

	// The total number of service templates in the Amazon Web Services account. The
	// serviceTemplates object will only contain total members.
	ServiceTemplates *ResourceCountsSummary

	// The staleness counts for Proton services in the Amazon Web Services account.
	Services *ResourceCountsSummary
	// contains filtered or unexported fields
}

Summary counts of each Proton resource type.

type Deployment added in v1.22.0 

type Deployment struct {

	// The Amazon Resource Name (ARN) of the deployment.
	//
	// This member is required.
	Arn *string

	// The date and time the deployment was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The status of the deployment.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the environment associated with this deployment.
	//
	// This member is required.
	EnvironmentName *string

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

	// The date and time the deployment was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The Amazon Resource Name (ARN) of the target of the deployment.
	//
	// This member is required.
	TargetArn *string

	// The date and time the depoyment target was created.
	//
	// This member is required.
	TargetResourceCreatedAt *time.Time

	// The resource type of the deployment target. It can be an environment, service,
	// service instance, or component.
	//
	// This member is required.
	TargetResourceType DeploymentTargetResourceType

	// The date and time the deployment was completed.
	CompletedAt *time.Time

	// The name of the component associated with this deployment.
	ComponentName *string

	// The deployment status message.
	DeploymentStatusMessage *string

	// The initial state of the target resource at the time of the deployment.
	InitialState DeploymentState

	// The ID of the last attempted deployment.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment.
	LastSucceededDeploymentId *string

	// The name of the deployment's service instance.
	ServiceInstanceName *string

	// The name of the service in this deployment.
	ServiceName *string

	// The target state of the target resource at the time of the deployment.
	TargetState DeploymentState
	// contains filtered or unexported fields
}

The detailed information about a deployment.

type DeploymentState added in v1.22.0 

type DeploymentState interface {
	// contains filtered or unexported methods
}

The detailed data about the current state of the deployment.

The following types satisfy this interface: 

DeploymentStateMemberComponent
DeploymentStateMemberEnvironment
DeploymentStateMemberServiceInstance
DeploymentStateMemberServicePipeline
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/proton/types"
)

func main() {
	var union types.DeploymentState
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DeploymentStateMemberComponent:
		_ = v.Value // Value is types.ComponentState

	case *types.DeploymentStateMemberEnvironment:
		_ = v.Value // Value is types.EnvironmentState

	case *types.DeploymentStateMemberServiceInstance:
		_ = v.Value // Value is types.ServiceInstanceState

	case *types.DeploymentStateMemberServicePipeline:
		_ = v.Value // Value is types.ServicePipelineState

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DeploymentStateMemberComponent added in v1.22.0 

type DeploymentStateMemberComponent struct {
	Value ComponentState
	// contains filtered or unexported fields
}

The state of the component associated with the deployment.

type DeploymentStateMemberEnvironment added in v1.22.0 

type DeploymentStateMemberEnvironment struct {
	Value EnvironmentState
	// contains filtered or unexported fields
}

The state of the environment associated with the deployment.

type DeploymentStateMemberServiceInstance added in v1.22.0 

type DeploymentStateMemberServiceInstance struct {
	Value ServiceInstanceState
	// contains filtered or unexported fields
}

The state of the service instance associated with the deployment.

type DeploymentStateMemberServicePipeline added in v1.22.0 

type DeploymentStateMemberServicePipeline struct {
	Value ServicePipelineState
	// contains filtered or unexported fields
}

The state of the service pipeline associated with the deployment.

type DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusInProgress       DeploymentStatus = "IN_PROGRESS"
	DeploymentStatusFailed           DeploymentStatus = "FAILED"
	DeploymentStatusSucceeded        DeploymentStatus = "SUCCEEDED"
	DeploymentStatusDeleteInProgress DeploymentStatus = "DELETE_IN_PROGRESS"
	DeploymentStatusDeleteFailed     DeploymentStatus = "DELETE_FAILED"
	DeploymentStatusDeleteComplete   DeploymentStatus = "DELETE_COMPLETE"
	DeploymentStatusCancelling       DeploymentStatus = "CANCELLING"
	DeploymentStatusCancelled        DeploymentStatus = "CANCELLED"
)

Enum values for DeploymentStatus

func (DeploymentStatus) Values 

func (DeploymentStatus) Values() []DeploymentStatus

Values returns all known values for DeploymentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentSummary added in v1.22.0 

type DeploymentSummary struct {

	// The Amazon Resource Name (ARN) of the deployment.
	//
	// This member is required.
	Arn *string

	// The date and time the deployment was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The current status of the deployment.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the environment associated with the deployment.
	//
	// This member is required.
	EnvironmentName *string

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

	// The date and time the deployment was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The Amazon Resource Name (ARN) of the target of the deployment.
	//
	// This member is required.
	TargetArn *string

	// The date and time the target resource was created.
	//
	// This member is required.
	TargetResourceCreatedAt *time.Time

	// The resource type of the deployment target. It can be an environment, service,
	// service instance, or component.
	//
	// This member is required.
	TargetResourceType DeploymentTargetResourceType

	// The date and time the deployment was completed.
	CompletedAt *time.Time

	// The name of the component associated with the deployment.
	ComponentName *string

	// The ID of the last attempted deployment.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment.
	LastSucceededDeploymentId *string

	// The name of the service instance associated with the deployment.
	ServiceInstanceName *string

	// The name of the service associated with the deployment.
	ServiceName *string
	// contains filtered or unexported fields
}

Summary data of the deployment.

type DeploymentTargetResourceType added in v1.22.0 

type DeploymentTargetResourceType string
const (
	DeploymentTargetResourceTypeEnvironment     DeploymentTargetResourceType = "ENVIRONMENT"
	DeploymentTargetResourceTypeServicePipeline DeploymentTargetResourceType = "SERVICE_PIPELINE"
	DeploymentTargetResourceTypeServiceInstance DeploymentTargetResourceType = "SERVICE_INSTANCE"
	DeploymentTargetResourceTypeComponent       DeploymentTargetResourceType = "COMPONENT"
)

Enum values for DeploymentTargetResourceType

func (DeploymentTargetResourceType) Values added in v1.22.0 

func (DeploymentTargetResourceType) Values() []DeploymentTargetResourceType

Values returns all known values for DeploymentTargetResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentUpdateType 

type DeploymentUpdateType string
const (
	DeploymentUpdateTypeNone           DeploymentUpdateType = "NONE"
	DeploymentUpdateTypeCurrentVersion DeploymentUpdateType = "CURRENT_VERSION"
	DeploymentUpdateTypeMinorVersion   DeploymentUpdateType = "MINOR_VERSION"
	DeploymentUpdateTypeMajorVersion   DeploymentUpdateType = "MAJOR_VERSION"
)

Enum values for DeploymentUpdateType

func (DeploymentUpdateType) Values 

func (DeploymentUpdateType) Values() []DeploymentUpdateType

Values returns all known values for DeploymentUpdateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Environment 

type Environment struct {

	// The Amazon Resource Name (ARN) of the environment.
	//
	// This member is required.
	Arn *string

	// The time when the environment was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The environment deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The time when a deployment of the environment was last attempted.
	//
	// This member is required.
	LastDeploymentAttemptedAt *time.Time

	// The time when the environment was last deployed successfully.
	//
	// This member is required.
	LastDeploymentSucceededAt *time.Time

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

	// The major version of the environment template.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the environment template.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The Amazon Resource Name (ARN) of the environment template.
	//
	// This member is required.
	TemplateName *string

	// The Amazon Resource Name (ARN) of the IAM service role that allows Proton to
	// provision infrastructure using CodeBuild-based provisioning on your behalf.
	CodebuildRoleArn *string

	// The Amazon Resource Name (ARN) of the IAM service role that Proton uses when
	// provisioning directly defined components in this environment. It determines the
	// scope of infrastructure that a component can provision.
	//
	// The environment must have a componentRoleArn to allow directly defined
	// components to be associated with the environment.
	//
	// For more information about components, see [Proton components] in the Proton User Guide.
	//
	// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
	ComponentRoleArn *string

	// An environment deployment status message.
	DeploymentStatusMessage *string

	// The description of the environment.
	Description *string

	// The ID of the environment account connection that's used to provision
	// infrastructure resources in an environment account.
	EnvironmentAccountConnectionId *string

	// The ID of the environment account that the environment infrastructure resources
	// are provisioned in.
	EnvironmentAccountId *string

	// The ID of the last attempted deployment of this environment.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment of this environment.
	LastSucceededDeploymentId *string

	// The Amazon Resource Name (ARN) of the Proton service role that allows Proton to
	// make calls to other services on your behalf.
	ProtonServiceRoleArn *string

	// When included, indicates that the environment template is for customer
	// provisioned and managed infrastructure.
	Provisioning Provisioning

	// The linked repository that you use to host your rendered infrastructure
	// templates for self-managed provisioning. A linked repository is a repository
	// that has been registered with Proton. For more information, see [CreateRepository].
	//
	// [CreateRepository]: https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html
	ProvisioningRepository *RepositoryBranch

	// The environment spec.
	//
	// This value conforms to the media type: application/yaml
	Spec *string
	// contains filtered or unexported fields
}

Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

type EnvironmentAccountConnection 

type EnvironmentAccountConnection struct {

	// The Amazon Resource Name (ARN) of the environment account connection.
	//
	// This member is required.
	Arn *string

	// The environment account that's connected to the environment account connection.
	//
	// This member is required.
	EnvironmentAccountId *string

	// The name of the environment that's associated with the environment account
	// connection.
	//
	// This member is required.
	EnvironmentName *string

	// The ID of the environment account connection.
	//
	// This member is required.
	Id *string

	// The time when the environment account connection was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The ID of the management account that's connected to the environment account
	// connection.
	//
	// This member is required.
	ManagementAccountId *string

	// The time when the environment account connection request was made.
	//
	// This member is required.
	RequestedAt *time.Time

	// The IAM service role that's associated with the environment account connection.
	//
	// This member is required.
	RoleArn *string

	// The status of the environment account connection.
	//
	// This member is required.
	Status EnvironmentAccountConnectionStatus

	// The Amazon Resource Name (ARN) of an IAM service role in the environment
	// account. Proton uses this role to provision infrastructure resources using
	// CodeBuild-based provisioning in the associated environment account.
	CodebuildRoleArn *string

	// The Amazon Resource Name (ARN) of the IAM service role that Proton uses when
	// provisioning directly defined components in the associated environment account.
	// It determines the scope of infrastructure that a component can provision in the
	// account.
	//
	// The environment account connection must have a componentRoleArn to allow
	// directly defined components to be associated with any environments running in
	// the account.
	//
	// For more information about components, see [Proton components] in the Proton User Guide.
	//
	// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
	ComponentRoleArn *string
	// contains filtered or unexported fields
}

Detailed data of an Proton environment account connection resource.

type EnvironmentAccountConnectionRequesterAccountType 

type EnvironmentAccountConnectionRequesterAccountType string
const (
	EnvironmentAccountConnectionRequesterAccountTypeManagementAccount  EnvironmentAccountConnectionRequesterAccountType = "MANAGEMENT_ACCOUNT"
	EnvironmentAccountConnectionRequesterAccountTypeEnvironmentAccount EnvironmentAccountConnectionRequesterAccountType = "ENVIRONMENT_ACCOUNT"
)

Enum values for EnvironmentAccountConnectionRequesterAccountType

func (EnvironmentAccountConnectionRequesterAccountType) Values 

func (EnvironmentAccountConnectionRequesterAccountType) Values() []EnvironmentAccountConnectionRequesterAccountType

Values returns all known values for EnvironmentAccountConnectionRequesterAccountType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EnvironmentAccountConnectionStatus 

type EnvironmentAccountConnectionStatus string
const (
	EnvironmentAccountConnectionStatusPending   EnvironmentAccountConnectionStatus = "PENDING"
	EnvironmentAccountConnectionStatusConnected EnvironmentAccountConnectionStatus = "CONNECTED"
	EnvironmentAccountConnectionStatusRejected  EnvironmentAccountConnectionStatus = "REJECTED"
)

Enum values for EnvironmentAccountConnectionStatus

func (EnvironmentAccountConnectionStatus) Values 

func (EnvironmentAccountConnectionStatus) Values() []EnvironmentAccountConnectionStatus

Values returns all known values for EnvironmentAccountConnectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EnvironmentAccountConnectionSummary 

type EnvironmentAccountConnectionSummary struct {

	// The Amazon Resource Name (ARN) of the environment account connection.
	//
	// This member is required.
	Arn *string

	// The ID of the environment account that's connected to the environment account
	// connection.
	//
	// This member is required.
	EnvironmentAccountId *string

	// The name of the environment that's associated with the environment account
	// connection.
	//
	// This member is required.
	EnvironmentName *string

	// The ID of the environment account connection.
	//
	// This member is required.
	Id *string

	// The time when the environment account connection was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The ID of the management account that's connected to the environment account
	// connection.
	//
	// This member is required.
	ManagementAccountId *string

	// The time when the environment account connection request was made.
	//
	// This member is required.
	RequestedAt *time.Time

	// The IAM service role that's associated with the environment account connection.
	//
	// This member is required.
	RoleArn *string

	// The status of the environment account connection.
	//
	// This member is required.
	Status EnvironmentAccountConnectionStatus

	// The Amazon Resource Name (ARN) of the IAM service role that Proton uses when
	// provisioning directly defined components in the associated environment account.
	// It determines the scope of infrastructure that a component can provision in the
	// account.
	//
	// The environment account connection must have a componentRoleArn to allow
	// directly defined components to be associated with any environments running in
	// the account.
	//
	// For more information about components, see [Proton components] in the Proton User Guide.
	//
	// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
	ComponentRoleArn *string
	// contains filtered or unexported fields
}

Summary data of an Proton environment account connection resource.

type EnvironmentState added in v1.22.0 

type EnvironmentState struct {

	// The major version of the environment template that was used to create the
	// environment.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the environment template that was used to create the
	// environment.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the environment template that was used to create the environment.
	//
	// This member is required.
	TemplateName *string

	// The environment spec that was used to create the environment.
	//
	// This value conforms to the media type: application/yaml
	Spec *string
	// contains filtered or unexported fields
}

The detailed data about the current state of the environment.

type EnvironmentSummary 

type EnvironmentSummary struct {

	// The Amazon Resource Name (ARN) of the environment.
	//
	// This member is required.
	Arn *string

	// The time when the environment was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The environment deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The time when a deployment of the environment was last attempted.
	//
	// This member is required.
	LastDeploymentAttemptedAt *time.Time

	// The time when the environment was last deployed successfully.
	//
	// This member is required.
	LastDeploymentSucceededAt *time.Time

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

	// The major version of the environment template.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the environment template.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the environment template.
	//
	// This member is required.
	TemplateName *string

	// The Amazon Resource Name (ARN) of the IAM service role that Proton uses when
	// provisioning directly defined components in this environment. It determines the
	// scope of infrastructure that a component can provision.
	//
	// The environment must have a componentRoleArn to allow directly defined
	// components to be associated with the environment.
	//
	// For more information about components, see [Proton components] in the Proton User Guide.
	//
	// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
	ComponentRoleArn *string

	// An environment deployment status message.
	DeploymentStatusMessage *string

	// The description of the environment.
	Description *string

	// The ID of the environment account connection that the environment is associated
	// with.
	EnvironmentAccountConnectionId *string

	// The ID of the environment account that the environment infrastructure resources
	// are provisioned in.
	EnvironmentAccountId *string

	// The ID of the last attempted deployment of this environment.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment of this environment.
	LastSucceededDeploymentId *string

	// The Amazon Resource Name (ARN) of the Proton service role that allows Proton to
	// make calls to other services on your behalf.
	ProtonServiceRoleArn *string

	// When included, indicates that the environment template is for customer
	// provisioned and managed infrastructure.
	Provisioning Provisioning
	// contains filtered or unexported fields
}

Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

type EnvironmentTemplate 

type EnvironmentTemplate struct {

	// The Amazon Resource Name (ARN) of the environment template.
	//
	// This member is required.
	Arn *string

	// The time when the environment template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the environment template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// A description of the environment template.
	Description *string

	// The name of the environment template as displayed in the developer interface.
	DisplayName *string

	// The customer provided encryption key for the environment template.
	EncryptionKey *string

	// When included, indicates that the environment template is for customer
	// provisioned and managed infrastructure.
	Provisioning Provisioning

	// The ID of the recommended version of the environment template.
	RecommendedVersion *string
	// contains filtered or unexported fields
}

The environment template data.

type EnvironmentTemplateFilter 

type EnvironmentTemplateFilter struct {

	// Include majorVersion to filter search for a major version.
	//
	// This member is required.
	MajorVersion *string

	// Include templateName to filter search for a template name.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

A search filter for environment templates.

type EnvironmentTemplateSummary 

type EnvironmentTemplateSummary struct {

	// The Amazon Resource Name (ARN) of the environment template.
	//
	// This member is required.
	Arn *string

	// The time when the environment template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the environment template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// A description of the environment template.
	Description *string

	// The name of the environment template as displayed in the developer interface.
	DisplayName *string

	// When included, indicates that the environment template is for customer
	// provisioned and managed infrastructure.
	Provisioning Provisioning

	// The recommended version of the environment template.
	RecommendedVersion *string
	// contains filtered or unexported fields
}

The environment template data.

type EnvironmentTemplateVersion 

type EnvironmentTemplateVersion struct {

	// The Amazon Resource Name (ARN) of the version of an environment template.
	//
	// This member is required.
	Arn *string

	// The time when the version of an environment template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the version of an environment template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The latest major version that's associated with the version of an environment
	// template.
	//
	// This member is required.
	MajorVersion *string

	// The minor version of an environment template.
	//
	// This member is required.
	MinorVersion *string

	// The status of the version of an environment template.
	//
	// This member is required.
	Status TemplateVersionStatus

	// The name of the version of an environment template.
	//
	// This member is required.
	TemplateName *string

	// A description of the minor version of an environment template.
	Description *string

	// The recommended minor version of the environment template.
	RecommendedMinorVersion *string

	// The schema of the version of an environment template.
	//
	// This value conforms to the media type: application/yaml
	Schema *string

	// The status message of the version of an environment template.
	StatusMessage *string
	// contains filtered or unexported fields
}

The environment template version data.

type EnvironmentTemplateVersionSummary 

type EnvironmentTemplateVersionSummary struct {

	// The Amazon Resource Name (ARN) of the version of an environment template.
	//
	// This member is required.
	Arn *string

	// The time when the version of an environment template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the version of an environment template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The latest major version that's associated with the version of an environment
	// template.
	//
	// This member is required.
	MajorVersion *string

	// The version of an environment template.
	//
	// This member is required.
	MinorVersion *string

	// The status of the version of an environment template.
	//
	// This member is required.
	Status TemplateVersionStatus

	// The name of the environment template.
	//
	// This member is required.
	TemplateName *string

	// A description of the version of an environment template.
	Description *string

	// The recommended minor version of the environment template.
	RecommendedMinorVersion *string

	// The status message of the version of an environment template.
	StatusMessage *string
	// contains filtered or unexported fields
}

A summary of the version of an environment template detail data.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request failed to register with the service.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ListServiceInstancesFilter added in v1.17.0 

type ListServiceInstancesFilter struct {

	// The name of a filtering criterion.
	Key ListServiceInstancesFilterBy

	// A value to filter by.
	//
	// With the date/time keys ( *At{Before,After} ), the value is a valid [RFC 3339] string
	// with no UTC offset and with an optional fractional precision (for example,
	// 1985-04-12T23:20:50.52Z ).
	//
	// [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339.html
	Value *string
	// contains filtered or unexported fields
}

A filtering criterion to scope down the result list of the ListServiceInstances action.

type ListServiceInstancesFilterBy added in v1.17.0 

type ListServiceInstancesFilterBy string
const (
	ListServiceInstancesFilterByName                            ListServiceInstancesFilterBy = "name"
	ListServiceInstancesFilterByDeploymentStatus                ListServiceInstancesFilterBy = "deploymentStatus"
	ListServiceInstancesFilterByTemplateName                    ListServiceInstancesFilterBy = "templateName"
	ListServiceInstancesFilterByServiceName                     ListServiceInstancesFilterBy = "serviceName"
	ListServiceInstancesFilterByDeployedTemplateVersionStatus   ListServiceInstancesFilterBy = "deployedTemplateVersionStatus"
	ListServiceInstancesFilterByEnvironmentName                 ListServiceInstancesFilterBy = "environmentName"
	ListServiceInstancesFilterByLastDeploymentAttemptedAtBefore ListServiceInstancesFilterBy = "lastDeploymentAttemptedAtBefore"
	ListServiceInstancesFilterByLastDeploymentAttemptedAtAfter  ListServiceInstancesFilterBy = "lastDeploymentAttemptedAtAfter"
	ListServiceInstancesFilterByCreatedAtBefore                 ListServiceInstancesFilterBy = "createdAtBefore"
	ListServiceInstancesFilterByCreatedAtAfter                  ListServiceInstancesFilterBy = "createdAtAfter"
)

Enum values for ListServiceInstancesFilterBy

func (ListServiceInstancesFilterBy) Values added in v1.17.0 

func (ListServiceInstancesFilterBy) Values() []ListServiceInstancesFilterBy

Values returns all known values for ListServiceInstancesFilterBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListServiceInstancesSortBy added in v1.17.0 

type ListServiceInstancesSortBy string
const (
	ListServiceInstancesSortByName                      ListServiceInstancesSortBy = "name"
	ListServiceInstancesSortByDeploymentStatus          ListServiceInstancesSortBy = "deploymentStatus"
	ListServiceInstancesSortByTemplateName              ListServiceInstancesSortBy = "templateName"
	ListServiceInstancesSortByServiceName               ListServiceInstancesSortBy = "serviceName"
	ListServiceInstancesSortByEnvironmentName           ListServiceInstancesSortBy = "environmentName"
	ListServiceInstancesSortByLastDeploymentAttemptedAt ListServiceInstancesSortBy = "lastDeploymentAttemptedAt"
	ListServiceInstancesSortByCreatedAt                 ListServiceInstancesSortBy = "createdAt"
)

Enum values for ListServiceInstancesSortBy

func (ListServiceInstancesSortBy) Values added in v1.17.0 

func (ListServiceInstancesSortBy) Values() []ListServiceInstancesSortBy

Values returns all known values for ListServiceInstancesSortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Output added in v1.7.0 

type Output struct {

	// The output key.
	Key *string

	// The output value.
	ValueString *string
	// contains filtered or unexported fields
}

An infrastructure as code defined resource output.

type ProvisionedResource added in v1.7.0 

type ProvisionedResource struct {

	// The provisioned resource identifier.
	Identifier *string

	// The provisioned resource name.
	Name *string

	// The resource provisioning engine. At this time, CLOUDFORMATION can be used for
	// Amazon Web Services-managed provisioning, and TERRAFORM can be used for
	// self-managed provisioning.
	//
	// For more information, see [Self-managed provisioning] in the Proton User Guide.
	//
	// [Self-managed provisioning]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self
	ProvisioningEngine ProvisionedResourceEngine
	// contains filtered or unexported fields
}

Detail data for a provisioned resource.

type ProvisionedResourceEngine added in v1.7.0 

type ProvisionedResourceEngine string
const (
	ProvisionedResourceEngineCloudformation ProvisionedResourceEngine = "CLOUDFORMATION"
	ProvisionedResourceEngineTerraform      ProvisionedResourceEngine = "TERRAFORM"
)

Enum values for ProvisionedResourceEngine

func (ProvisionedResourceEngine) Values added in v1.7.0 

func (ProvisionedResourceEngine) Values() []ProvisionedResourceEngine

Values returns all known values for ProvisionedResourceEngine. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Provisioning 

type Provisioning string
const (
	ProvisioningCustomerManaged Provisioning = "CUSTOMER_MANAGED"
)

Enum values for Provisioning

func (Provisioning) Values 

func (Provisioning) Values() []Provisioning

Values returns all known values for Provisioning. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Repository added in v1.7.0 

type Repository struct {

	// The Amazon Resource Name (ARN) of the linked repository.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects
	// Proton to your repository provider account.
	//
	// This member is required.
	ConnectionArn *string

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

	// The repository provider.
	//
	// This member is required.
	Provider RepositoryProvider

	// Your customer Amazon Web Services KMS encryption key.
	EncryptionKey *string
	// contains filtered or unexported fields
}

Detailed data of a linked repository—a repository that has been registered with Proton.

type RepositoryBranch added in v1.7.0 

type RepositoryBranch struct {

	// The Amazon Resource Name (ARN) of the linked repository.
	//
	// This member is required.
	Arn *string

	// The repository branch.
	//
	// This member is required.
	Branch *string

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

	// The repository provider.
	//
	// This member is required.
	Provider RepositoryProvider
	// contains filtered or unexported fields
}

Detail data for a linked repository branch.

type RepositoryBranchInput added in v1.7.0 

type RepositoryBranchInput struct {

	// The repository branch.
	//
	// This member is required.
	Branch *string

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

	// The repository provider.
	//
	// This member is required.
	Provider RepositoryProvider
	// contains filtered or unexported fields
}

Detail input data for a linked repository branch.

type RepositoryProvider added in v1.7.0 

type RepositoryProvider string
const (
	RepositoryProviderGithub           RepositoryProvider = "GITHUB"
	RepositoryProviderGithubEnterprise RepositoryProvider = "GITHUB_ENTERPRISE"
	RepositoryProviderBitbucket        RepositoryProvider = "BITBUCKET"
)

Enum values for RepositoryProvider

func (RepositoryProvider) Values added in v1.7.0 

func (RepositoryProvider) Values() []RepositoryProvider

Values returns all known values for RepositoryProvider. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RepositorySummary added in v1.7.0 

type RepositorySummary struct {

	// The Amazon Resource Name (ARN) of the linked repository.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the of your connection that connects Proton
	// to your repository.
	//
	// This member is required.
	ConnectionArn *string

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

	// The repository provider.
	//
	// This member is required.
	Provider RepositoryProvider
	// contains filtered or unexported fields
}

Summary data of a linked repository—a repository that has been registered with Proton.

type RepositorySyncAttempt added in v1.7.0 

type RepositorySyncAttempt struct {

	// Detail data for sync attempt events.
	//
	// This member is required.
	Events []RepositorySyncEvent

	// The time when the sync attempt started.
	//
	// This member is required.
	StartedAt *time.Time

	// The sync attempt status.
	//
	// This member is required.
	Status RepositorySyncStatus
	// contains filtered or unexported fields
}

Detail data for a repository sync attempt activated by a push to a repository.

type RepositorySyncDefinition added in v1.7.0 

type RepositorySyncDefinition struct {

	// The repository branch.
	//
	// This member is required.
	Branch *string

	// The directory in the repository.
	//
	// This member is required.
	Directory *string

	// The resource that is synced from.
	//
	// This member is required.
	Parent *string

	// The resource that is synced to.
	//
	// This member is required.
	Target *string
	// contains filtered or unexported fields
}

A repository sync definition.

type RepositorySyncEvent added in v1.7.0 

type RepositorySyncEvent struct {

	// Event detail for a repository sync attempt.
	//
	// This member is required.
	Event *string

	// The time that the sync event occurred.
	//
	// This member is required.
	Time *time.Time

	// The type of event.
	//
	// This member is required.
	Type *string

	// The external ID of the sync event.
	ExternalId *string
	// contains filtered or unexported fields
}

Repository sync event detail data for a sync attempt.

type RepositorySyncStatus added in v1.7.0 

type RepositorySyncStatus string
const (
	// A repository sync attempt has been created and will begin soon.
	RepositorySyncStatusInitiated RepositorySyncStatus = "INITIATED"
	// A repository sync attempt has started and work is being done to reconcile the
	// branch.
	RepositorySyncStatusInProgress RepositorySyncStatus = "IN_PROGRESS"
	// The repository sync attempt has completed successfully.
	RepositorySyncStatusSucceeded RepositorySyncStatus = "SUCCEEDED"
	// The repository sync attempt has failed.
	RepositorySyncStatusFailed RepositorySyncStatus = "FAILED"
	// The repository sync attempt didn't execute and was queued.
	RepositorySyncStatusQueued RepositorySyncStatus = "QUEUED"
)

Enum values for RepositorySyncStatus

func (RepositorySyncStatus) Values added in v1.7.0 

func (RepositorySyncStatus) Values() []RepositorySyncStatus

Values returns all known values for RepositorySyncStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceCountsSummary added in v1.20.0 

type ResourceCountsSummary struct {

	// The total number of resources of this type in the Amazon Web Services account.
	//
	// This member is required.
	Total *int32

	// The number of resources of this type in the Amazon Web Services account that
	// need a major template version update.
	BehindMajor *int32

	// The number of resources of this type in the Amazon Web Services account that
	// need a minor template version update.
	BehindMinor *int32

	// The number of resources of this type in the Amazon Web Services account that
	// failed to deploy.
	Failed *int32

	// The number of resources of this type in the Amazon Web Services account that
	// are up-to-date with their template.
	UpToDate *int32
	// contains filtered or unexported fields
}

Summary counts of each Proton resource types.

type ResourceDeploymentStatus added in v1.7.0 

type ResourceDeploymentStatus string
const (
	ResourceDeploymentStatusInProgress ResourceDeploymentStatus = "IN_PROGRESS"
	ResourceDeploymentStatusFailed     ResourceDeploymentStatus = "FAILED"
	ResourceDeploymentStatusSucceeded  ResourceDeploymentStatus = "SUCCEEDED"
)

Enum values for ResourceDeploymentStatus

func (ResourceDeploymentStatus) Values added in v1.7.0 

func (ResourceDeploymentStatus) Values() []ResourceDeploymentStatus

Values returns all known values for ResourceDeploymentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The requested resource wasn't found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceSyncAttempt added in v1.7.0 

type ResourceSyncAttempt struct {

	// An array of events with detail data.
	//
	// This member is required.
	Events []ResourceSyncEvent

	// Detail data for the initial repository commit, path and push.
	//
	// This member is required.
	InitialRevision *Revision

	// The time when the sync attempt started.
	//
	// This member is required.
	StartedAt *time.Time

	// The status of the sync attempt.
	//
	// This member is required.
	Status ResourceSyncStatus

	// The resource that is synced to.
	//
	// This member is required.
	Target *string

	// Detail data for the target revision.
	//
	// This member is required.
	TargetRevision *Revision
	// contains filtered or unexported fields
}

Detail data for a resource sync attempt activated by a push to a repository.

type ResourceSyncEvent added in v1.7.0 

type ResourceSyncEvent struct {

	// A resource sync event.
	//
	// This member is required.
	Event *string

	// The time when the event occurred.
	//
	// This member is required.
	Time *time.Time

	// The type of event.
	//
	// This member is required.
	Type *string

	// The external ID for the event.
	ExternalId *string
	// contains filtered or unexported fields
}

Detail data for a resource sync event.

type ResourceSyncStatus added in v1.7.0 

type ResourceSyncStatus string
const (
	// A sync attempt has been created and will begin soon.
	ResourceSyncStatusInitiated ResourceSyncStatus = "INITIATED"
	// Syncing has started and work is being done to reconcile state.
	ResourceSyncStatusInProgress ResourceSyncStatus = "IN_PROGRESS"
	// Syncing has completed successfully.
	ResourceSyncStatusSucceeded ResourceSyncStatus = "SUCCEEDED"
	// Syncing has failed.
	ResourceSyncStatusFailed ResourceSyncStatus = "FAILED"
)

Enum values for ResourceSyncStatus

func (ResourceSyncStatus) Values added in v1.7.0 

func (ResourceSyncStatus) Values() []ResourceSyncStatus

Values returns all known values for ResourceSyncStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Revision added in v1.7.0 

type Revision struct {

	// The repository branch.
	//
	// This member is required.
	Branch *string

	// The repository directory changed by a commit and push that activated the sync
	// attempt.
	//
	// This member is required.
	Directory *string

	// The repository name.
	//
	// This member is required.
	RepositoryName *string

	// The repository provider.
	//
	// This member is required.
	RepositoryProvider RepositoryProvider

	// The secure hash algorithm (SHA) hash for the revision.
	//
	// This member is required.
	Sha *string
	// contains filtered or unexported fields
}

Revision detail data for a commit and push that activates a sync attempt

type S3ObjectSource 

type S3ObjectSource struct {

	// The name of the S3 bucket that contains a template bundle.
	//
	// This member is required.
	Bucket *string

	// The path to the S3 bucket that contains a template bundle.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

Template bundle S3 bucket data.

type Service 

type Service struct {

	// The Amazon Resource Name (ARN) of the service.
	//
	// This member is required.
	Arn *string

	// The time when the service was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the service was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// The formatted specification that defines the service.
	//
	// This value conforms to the media type: application/yaml
	//
	// This member is required.
	Spec *string

	// The status of the service.
	//
	// This member is required.
	Status ServiceStatus

	// The name of the service template.
	//
	// This member is required.
	TemplateName *string

	// The name of the code repository branch that holds the code that's deployed in
	// Proton.
	BranchName *string

	// A description of the service.
	Description *string

	// The service pipeline detail data.
	Pipeline *ServicePipeline

	// The Amazon Resource Name (ARN) of the repository connection. For more
	// information, see [Setting up an AWS CodeStar connection]in the Proton User Guide.
	//
	// [Setting up an AWS CodeStar connection]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol
	RepositoryConnectionArn *string

	// The ID of the source code repository.
	RepositoryId *string

	// A service status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Detailed data of an Proton service resource.

type ServiceInstance 

type ServiceInstance struct {

	// The Amazon Resource Name (ARN) of the service instance.
	//
	// This member is required.
	Arn *string

	// The time when the service instance was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The service instance deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the environment that the service instance was deployed into.
	//
	// This member is required.
	EnvironmentName *string

	// The time when a deployment of the service instance was last attempted.
	//
	// This member is required.
	LastDeploymentAttemptedAt *time.Time

	// The time when the service instance was last deployed successfully.
	//
	// This member is required.
	LastDeploymentSucceededAt *time.Time

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

	// The name of the service that the service instance belongs to.
	//
	// This member is required.
	ServiceName *string

	// The major version of the service template that was used to create the service
	// instance.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the service template that was used to create the service
	// instance.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the service template that was used to create the service instance.
	//
	// This member is required.
	TemplateName *string

	// The message associated with the service instance deployment status.
	DeploymentStatusMessage *string

	// The ID of the last attempted deployment of this service instance.
	LastAttemptedDeploymentId *string

	// The last client request token received.
	LastClientRequestToken *string

	// The ID of the last successful deployment of this service instance.
	LastSucceededDeploymentId *string

	// The service spec that was used to create the service instance.
	//
	// This value conforms to the media type: application/yaml
	Spec *string
	// contains filtered or unexported fields
}

Detailed data of an Proton service instance resource.

type ServiceInstanceState added in v1.22.0 

type ServiceInstanceState struct {

	// The service spec that was used to create the service instance.
	//
	// This value conforms to the media type: application/yaml
	//
	// This member is required.
	Spec *string

	// The major version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the service template that was used to create the service instance.
	//
	// This member is required.
	TemplateName *string

	// The IDs for the last successful components deployed for this service instance.
	LastSuccessfulComponentDeploymentIds []string

	// The ID for the last successful environment deployed for this service instance.
	LastSuccessfulEnvironmentDeploymentId *string

	// The ID for the last successful service pipeline deployed for this service
	// instance.
	LastSuccessfulServicePipelineDeploymentId *string
	// contains filtered or unexported fields
}

The detailed data about the current state of this service instance.

type ServiceInstanceSummary 

type ServiceInstanceSummary struct {

	// The Amazon Resource Name (ARN) of the service instance.
	//
	// This member is required.
	Arn *string

	// The time when the service instance was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The service instance deployment status.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The name of the environment that the service instance was deployed into.
	//
	// This member is required.
	EnvironmentName *string

	// The time when a deployment of the service was last attempted.
	//
	// This member is required.
	LastDeploymentAttemptedAt *time.Time

	// The time when the service was last deployed successfully.
	//
	// This member is required.
	LastDeploymentSucceededAt *time.Time

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

	// The name of the service that the service instance belongs to.
	//
	// This member is required.
	ServiceName *string

	// The service instance template major version.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The service instance template minor version.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the service template.
	//
	// This member is required.
	TemplateName *string

	// A service instance deployment status message.
	DeploymentStatusMessage *string

	// The ID of the last attempted deployment of this service instance.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment of this service instance.
	LastSucceededDeploymentId *string
	// contains filtered or unexported fields
}

Summary data of an Proton service instance resource.

type ServicePipeline 

type ServicePipeline struct {

	// The Amazon Resource Name (ARN) of the service pipeline.
	//
	// This member is required.
	Arn *string

	// The time when the service pipeline was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The deployment status of the service pipeline.
	//
	// This member is required.
	DeploymentStatus DeploymentStatus

	// The time when a deployment of the service pipeline was last attempted.
	//
	// This member is required.
	LastDeploymentAttemptedAt *time.Time

	// The time when the service pipeline was last deployed successfully.
	//
	// This member is required.
	LastDeploymentSucceededAt *time.Time

	// The major version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the service template that was used to create the service pipeline.
	//
	// This member is required.
	TemplateName *string

	// A service pipeline deployment status message.
	DeploymentStatusMessage *string

	// The ID of the last attempted deployment of this service pipeline.
	LastAttemptedDeploymentId *string

	// The ID of the last successful deployment of this service pipeline.
	LastSucceededDeploymentId *string

	// The service spec that was used to create the service pipeline.
	//
	// This value conforms to the media type: application/yaml
	Spec *string
	// contains filtered or unexported fields
}

Detailed data of an Proton service instance pipeline resource.

type ServicePipelineState added in v1.22.0 

type ServicePipelineState struct {

	// The major version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMajorVersion *string

	// The minor version of the service template that was used to create the service
	// pipeline.
	//
	// This member is required.
	TemplateMinorVersion *string

	// The name of the service template that was used to create the service pipeline.
	//
	// This member is required.
	TemplateName *string

	// The service spec that was used to create the service pipeline.
	//
	// This value conforms to the media type: application/yaml
	Spec *string
	// contains filtered or unexported fields
}

The detailed data about the current state of the service pipeline.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceStatus 

type ServiceStatus string
const (
	ServiceStatusCreateInProgress              ServiceStatus = "CREATE_IN_PROGRESS"
	ServiceStatusCreateFailedCleanupInProgress ServiceStatus = "CREATE_FAILED_CLEANUP_IN_PROGRESS"
	ServiceStatusCreateFailedCleanupComplete   ServiceStatus = "CREATE_FAILED_CLEANUP_COMPLETE"
	ServiceStatusCreateFailedCleanupFailed     ServiceStatus = "CREATE_FAILED_CLEANUP_FAILED"
	ServiceStatusCreateFailed                  ServiceStatus = "CREATE_FAILED"
	ServiceStatusActive                        ServiceStatus = "ACTIVE"
	ServiceStatusDeleteInProgress              ServiceStatus = "DELETE_IN_PROGRESS"
	ServiceStatusDeleteFailed                  ServiceStatus = "DELETE_FAILED"
	ServiceStatusUpdateInProgress              ServiceStatus = "UPDATE_IN_PROGRESS"
	ServiceStatusUpdateFailedCleanupInProgress ServiceStatus = "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
	ServiceStatusUpdateFailedCleanupComplete   ServiceStatus = "UPDATE_FAILED_CLEANUP_COMPLETE"
	ServiceStatusUpdateFailedCleanupFailed     ServiceStatus = "UPDATE_FAILED_CLEANUP_FAILED"
	ServiceStatusUpdateFailed                  ServiceStatus = "UPDATE_FAILED"
	ServiceStatusUpdateCompleteCleanupFailed   ServiceStatus = "UPDATE_COMPLETE_CLEANUP_FAILED"
)

Enum values for ServiceStatus

func (ServiceStatus) Values 

func (ServiceStatus) Values() []ServiceStatus

Values returns all known values for ServiceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceSummary 

type ServiceSummary struct {

	// The Amazon Resource Name (ARN) of the service.
	//
	// This member is required.
	Arn *string

	// The time when the service was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the service was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// The status of the service.
	//
	// This member is required.
	Status ServiceStatus

	// The name of the service template.
	//
	// This member is required.
	TemplateName *string

	// A description of the service.
	Description *string

	// A service status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Summary data of an Proton service resource.

type ServiceSyncBlockerSummary added in v1.21.0 

type ServiceSyncBlockerSummary struct {

	// The name of the service that you want to get the sync blocker summary for. If
	// given a service instance name and a service name, it will return the blockers
	// only applying to the instance that is blocked.
	//
	// If given only a service name, it will return the blockers that apply to all of
	// the instances. In order to get the blockers for a single instance, you will need
	// to make two distinct calls, one to get the sync blocker summary for the service
	// and the other to get the sync blocker for the service instance.
	//
	// This member is required.
	ServiceName *string

	// The latest active blockers for the synced service.
	LatestBlockers []SyncBlocker

	// The name of the service instance that you want sync your service configuration
	// with.
	ServiceInstanceName *string
	// contains filtered or unexported fields
}

If a service instance is manually updated, Proton wants to prevent accidentally overriding a manual change.

A blocker is created because of the manual update or deletion of a service instance. The summary describes the blocker as being active or resolved.

type ServiceSyncConfig added in v1.21.0 

type ServiceSyncConfig struct {

	// The name of the code repository branch that holds the service code Proton will
	// sync with.
	//
	// This member is required.
	Branch *string

	// The file path to the service sync configuration file.
	//
	// This member is required.
	FilePath *string

	// The name of the code repository that holds the service code Proton will sync
	// with.
	//
	// This member is required.
	RepositoryName *string

	// The name of the repository provider that holds the repository Proton will sync
	// with.
	//
	// This member is required.
	RepositoryProvider RepositoryProvider

	// The name of the service that the service instance is added to.
	//
	// This member is required.
	ServiceName *string
	// contains filtered or unexported fields
}

Detailed data of the service sync configuration.

type ServiceTemplate 

type ServiceTemplate struct {

	// The Amazon Resource Name (ARN) of the service template.
	//
	// This member is required.
	Arn *string

	// The time when the service template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the service template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// A description of the service template.
	Description *string

	// The service template name as displayed in the developer interface.
	DisplayName *string

	// The customer provided service template encryption key that's used to encrypt
	// data.
	EncryptionKey *string

	// If pipelineProvisioning is true , a service pipeline is included in the service
	// template. Otherwise, a service pipeline isn't included in the service template.
	PipelineProvisioning Provisioning

	// The recommended version of the service template.
	RecommendedVersion *string
	// contains filtered or unexported fields
}

Detailed data of an Proton service template resource.

type ServiceTemplateSummary 

type ServiceTemplateSummary struct {

	// The Amazon Resource Name (ARN) of the service template.
	//
	// This member is required.
	Arn *string

	// The time when the service template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the service template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

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

	// A description of the service template.
	Description *string

	// The service template name as displayed in the developer interface.
	DisplayName *string

	// If pipelineProvisioning is true , a service pipeline is included in the service
	// template, otherwise a service pipeline isn't included in the service template.
	PipelineProvisioning Provisioning

	// The recommended version of the service template.
	RecommendedVersion *string
	// contains filtered or unexported fields
}

Summary data of an Proton service template resource.

type ServiceTemplateSupportedComponentSourceType added in v1.14.0 

type ServiceTemplateSupportedComponentSourceType string
const (
	ServiceTemplateSupportedComponentSourceTypeDirectlyDefined ServiceTemplateSupportedComponentSourceType = "DIRECTLY_DEFINED"
)

Enum values for ServiceTemplateSupportedComponentSourceType

func (ServiceTemplateSupportedComponentSourceType) Values added in v1.14.0 

func (ServiceTemplateSupportedComponentSourceType) Values() []ServiceTemplateSupportedComponentSourceType

Values returns all known values for ServiceTemplateSupportedComponentSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceTemplateVersion 

type ServiceTemplateVersion struct {

	// The Amazon Resource Name (ARN) of the version of a service template.
	//
	// This member is required.
	Arn *string

	// An array of compatible environment template names for the major version of a
	// service template.
	//
	// This member is required.
	CompatibleEnvironmentTemplates []CompatibleEnvironmentTemplate

	// The time when the version of a service template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the version of a service template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The latest major version that's associated with the version of a service
	// template.
	//
	// This member is required.
	MajorVersion *string

	// The minor version of a service template.
	//
	// This member is required.
	MinorVersion *string

	// The service template version status.
	//
	// This member is required.
	Status TemplateVersionStatus

	// The name of the version of a service template.
	//
	// This member is required.
	TemplateName *string

	// A description of the version of a service template.
	Description *string

	// The recommended minor version of the service template.
	RecommendedMinorVersion *string

	// The schema of the version of a service template.
	//
	// This value conforms to the media type: application/yaml
	Schema *string

	// A service template version status message.
	StatusMessage *string

	// An array of supported component sources. Components with supported sources can
	// be attached to service instances based on this service template version.
	//
	// For more information about components, see [Proton components] in the Proton User Guide.
	//
	// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
	SupportedComponentSources []ServiceTemplateSupportedComponentSourceType
	// contains filtered or unexported fields
}

Detailed data of an Proton service template version resource.

type ServiceTemplateVersionSummary 

type ServiceTemplateVersionSummary struct {

	// The Amazon Resource Name (ARN) of the version of a service template.
	//
	// This member is required.
	Arn *string

	// The time when the version of a service template was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time when the version of a service template was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The latest major version that's associated with the version of a service
	// template.
	//
	// This member is required.
	MajorVersion *string

	// The minor version of a service template.
	//
	// This member is required.
	MinorVersion *string

	// The service template minor version status.
	//
	// This member is required.
	Status TemplateVersionStatus

	// The name of the service template.
	//
	// This member is required.
	TemplateName *string

	// A description of the version of a service template.
	Description *string

	// The recommended minor version of the service template.
	RecommendedMinorVersion *string

	// A service template minor version status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Summary data of an Proton service template version resource.

type SortOrder added in v1.17.0 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values added in v1.17.0 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SyncBlocker added in v1.21.0 

type SyncBlocker struct {

	// The time when the sync blocker was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The reason why the sync blocker was created.
	//
	// This member is required.
	CreatedReason *string

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

	// The status of the sync blocker.
	//
	// This member is required.
	Status BlockerStatus

	// The type of the sync blocker.
	//
	// This member is required.
	Type BlockerType

	// The contexts for the sync blocker.
	Contexts []SyncBlockerContext

	// The time the sync blocker was resolved.
	ResolvedAt *time.Time

	// The reason the sync blocker was resolved.
	ResolvedReason *string
	// contains filtered or unexported fields
}

Detailed data of the sync blocker.

type SyncBlockerContext added in v1.21.0 

type SyncBlockerContext struct {

	// The key for the sync blocker context.
	//
	// This member is required.
	Key *string

	// The value of the sync blocker context.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Detailed data of the context of the sync blocker.

type SyncType added in v1.7.0 

type SyncType string
const (
	// Syncs environment and service templates to Proton.
	SyncTypeTemplateSync SyncType = "TEMPLATE_SYNC"
	// Syncs services and service instances to Proton.
	SyncTypeServiceSync SyncType = "SERVICE_SYNC"
)

Enum values for SyncType

func (SyncType) Values added in v1.7.0 

func (SyncType) Values() []SyncType

Values returns all known values for SyncType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Tag 

type Tag struct {

	// The key of the resource tag.
	//
	// This member is required.
	Key *string

	// The value of the resource tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A description of a resource tag.

type TemplateSyncConfig added in v1.7.0 

type TemplateSyncConfig struct {

	// The repository branch.
	//
	// This member is required.
	Branch *string

	// The repository name (for example, myrepos/myrepo ).
	//
	// This member is required.
	RepositoryName *string

	// The repository provider.
	//
	// This member is required.
	RepositoryProvider RepositoryProvider

	// The template name.
	//
	// This member is required.
	TemplateName *string

	// The template type.
	//
	// This member is required.
	TemplateType TemplateType

	// A subdirectory path to your template bundle version.
	Subdirectory *string
	// contains filtered or unexported fields
}

The detail data for a template sync configuration.

type TemplateType added in v1.7.0 

type TemplateType string
const (
	TemplateTypeEnvironment TemplateType = "ENVIRONMENT"
	TemplateTypeService     TemplateType = "SERVICE"
)

Enum values for TemplateType

func (TemplateType) Values added in v1.7.0 

func (TemplateType) Values() []TemplateType

Values returns all known values for TemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateVersionSourceInput 

type TemplateVersionSourceInput interface {
	// contains filtered or unexported methods
}

Template version source data.

The following types satisfy this interface: 

TemplateVersionSourceInputMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/proton/types"
)

func main() {
	var union types.TemplateVersionSourceInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TemplateVersionSourceInputMemberS3:
		_ = v.Value // Value is types.S3ObjectSource

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type TemplateVersionSourceInputMemberS3 

type TemplateVersionSourceInputMemberS3 struct {
	Value S3ObjectSource
	// contains filtered or unexported fields
}

An S3 source object that includes the template bundle S3 path and name for a template minor version.

type TemplateVersionStatus 

type TemplateVersionStatus string
const (
	TemplateVersionStatusRegistrationInProgress TemplateVersionStatus = "REGISTRATION_IN_PROGRESS"
	TemplateVersionStatusRegistrationFailed     TemplateVersionStatus = "REGISTRATION_FAILED"
	TemplateVersionStatusDraft                  TemplateVersionStatus = "DRAFT"
	TemplateVersionStatusPublished              TemplateVersionStatus = "PUBLISHED"
)

Enum values for TemplateVersionStatus

func (TemplateVersionStatus) Values 

func (TemplateVersionStatus) Values() []TemplateVersionStatus

Values returns all known values for TemplateVersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input is invalid or an out-of-range value was supplied for the input parameter.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.