types

package
v1.28.4 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: 4 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessLevelFilter 

type AccessLevelFilter struct {

	// The access level.
	//   - Account - Filter results based on the account.
	//   - Role - Filter results based on the federated role of the specified user.
	//   - User - Filter results based on the specified user.
	Key AccessLevelFilterKey

	// The user to which the access level applies. The only supported value is self .
	Value *string
	// contains filtered or unexported fields
}

The access level to use to filter results.

type AccessLevelFilterKey 

type AccessLevelFilterKey string
const (
	AccessLevelFilterKeyAccount AccessLevelFilterKey = "Account"
	AccessLevelFilterKeyRole    AccessLevelFilterKey = "Role"
	AccessLevelFilterKeyUser    AccessLevelFilterKey = "User"
)

Enum values for AccessLevelFilterKey

func (AccessLevelFilterKey) Values added in v0.29.0 

func (AccessLevelFilterKey) Values() []AccessLevelFilterKey

Values returns all known values for AccessLevelFilterKey. 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 AccessStatus 

type AccessStatus string
const (
	AccessStatusEnabled     AccessStatus = "ENABLED"
	AccessStatusUnderChange AccessStatus = "UNDER_CHANGE"
	AccessStatusDisabled    AccessStatus = "DISABLED"
)

Enum values for AccessStatus

func (AccessStatus) Values added in v0.29.0 

func (AccessStatus) Values() []AccessStatus

Values returns all known values for AccessStatus. 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 BudgetDetail 

type BudgetDetail struct {

	// Name of the associated budget.
	BudgetName *string
	// contains filtered or unexported fields
}

Information about a budget.

type ChangeAction 

type ChangeAction string
const (
	ChangeActionAdd    ChangeAction = "ADD"
	ChangeActionModify ChangeAction = "MODIFY"
	ChangeActionRemove ChangeAction = "REMOVE"
)

Enum values for ChangeAction

func (ChangeAction) Values added in v0.29.0 

func (ChangeAction) Values() []ChangeAction

Values returns all known values for ChangeAction. 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 CloudWatchDashboard 

type CloudWatchDashboard struct {

	// The name of the CloudWatch dashboard.
	Name *string
	// contains filtered or unexported fields
}

Information about a CloudWatch dashboard.

type CodeStarParameters added in v1.15.0 

type CodeStarParameters struct {

	// The absolute path wehre the artifact resides within the repo and branch,
	// formatted as "folder/file.json."
	//
	// This member is required.
	ArtifactPath *string

	// The specific branch where the artifact resides.
	//
	// This member is required.
	Branch *string

	// The CodeStar ARN, which is the connection between Service Catalog and the
	// external repository.
	//
	// This member is required.
	ConnectionArn *string

	// The specific repository where the product’s artifact-to-be-synced resides,
	// formatted as "Account/Repo."
	//
	// This member is required.
	Repository *string
	// contains filtered or unexported fields
}

The subtype containing details about the Codestar connection Type .

type ConstraintDetail 

type ConstraintDetail struct {

	// The identifier of the constraint.
	ConstraintId *string

	// The description of the constraint.
	Description *string

	// The owner of the constraint.
	Owner *string

	// The identifier of the portfolio the product resides in. The constraint applies
	// only to the instance of the product that lives within this portfolio.
	PortfolioId *string

	// The identifier of the product the constraint applies to. Note that a constraint
	// applies to a specific instance of a product within a certain portfolio.
	ProductId *string

	// The type of constraint.
	//   - LAUNCH
	//   - NOTIFICATION
	//   - STACKSET
	//   - TEMPLATE
	Type *string
	// contains filtered or unexported fields
}

Information about a constraint.

type ConstraintSummary 

type ConstraintSummary struct {

	// The description of the constraint.
	Description *string

	// The type of constraint.
	//   - LAUNCH
	//   - NOTIFICATION
	//   - STACKSET
	//   - TEMPLATE
	Type *string
	// contains filtered or unexported fields
}

Summary information about a constraint.

type CopyOption 

type CopyOption string
const (
	CopyOptionCopyTags CopyOption = "CopyTags"
)

Enum values for CopyOption

func (CopyOption) Values added in v0.29.0 

func (CopyOption) Values() []CopyOption

Values returns all known values for CopyOption. 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 CopyProductStatus 

type CopyProductStatus string
const (
	CopyProductStatusSucceeded  CopyProductStatus = "SUCCEEDED"
	CopyProductStatusInProgress CopyProductStatus = "IN_PROGRESS"
	CopyProductStatusFailed     CopyProductStatus = "FAILED"
)

Enum values for CopyProductStatus

func (CopyProductStatus) Values added in v0.29.0 

func (CopyProductStatus) Values() []CopyProductStatus

Values returns all known values for CopyProductStatus. 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 DescribePortfolioShareType added in v0.31.0 

type DescribePortfolioShareType string
const (
	DescribePortfolioShareTypeAccount                   DescribePortfolioShareType = "ACCOUNT"
	DescribePortfolioShareTypeOrganization              DescribePortfolioShareType = "ORGANIZATION"
	DescribePortfolioShareTypeOrganizationalUnit        DescribePortfolioShareType = "ORGANIZATIONAL_UNIT"
	DescribePortfolioShareTypeOrganizationMemberAccount DescribePortfolioShareType = "ORGANIZATION_MEMBER_ACCOUNT"
)

Enum values for DescribePortfolioShareType

func (DescribePortfolioShareType) Values added in v0.31.0 

func (DescribePortfolioShareType) Values() []DescribePortfolioShareType

Values returns all known values for DescribePortfolioShareType. 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 DuplicateResourceException 

type DuplicateResourceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource is a duplicate.

func (*DuplicateResourceException) Error 

func (e *DuplicateResourceException) Error() string

func (*DuplicateResourceException) ErrorCode 

func (e *DuplicateResourceException) ErrorCode() string

func (*DuplicateResourceException) ErrorFault 

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

func (*DuplicateResourceException) ErrorMessage 

func (e *DuplicateResourceException) ErrorMessage() string

type EngineWorkflowResourceIdentifier added in v1.17.0 

type EngineWorkflowResourceIdentifier struct {

	// The unique key-value pair for a tag that identifies provisioned product
	// resources.
	UniqueTag *UniqueTagResourceIdentifier
	// contains filtered or unexported fields
}

The ID for the provisioned product resources that are part of a resource group.

type EngineWorkflowStatus added in v1.17.0 

type EngineWorkflowStatus string
const (
	EngineWorkflowStatusSucceeded EngineWorkflowStatus = "SUCCEEDED"
	EngineWorkflowStatusFailed    EngineWorkflowStatus = "FAILED"
)

Enum values for EngineWorkflowStatus

func (EngineWorkflowStatus) Values added in v1.17.0 

func (EngineWorkflowStatus) Values() []EngineWorkflowStatus

Values returns all known values for EngineWorkflowStatus. 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 EvaluationType 

type EvaluationType string
const (
	EvaluationTypeStatic  EvaluationType = "STATIC"
	EvaluationTypeDynamic EvaluationType = "DYNAMIC"
)

Enum values for EvaluationType

func (EvaluationType) Values added in v0.29.0 

func (EvaluationType) Values() []EvaluationType

Values returns all known values for EvaluationType. 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 ExecutionParameter 

type ExecutionParameter struct {

	// The default values for the execution parameter.
	DefaultValues []string

	// The name of the execution parameter.
	Name *string

	// The execution parameter type.
	Type *string
	// contains filtered or unexported fields
}

Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.

type FailedServiceActionAssociation 

type FailedServiceActionAssociation struct {

	// The error code. Valid values are listed below.
	ErrorCode ServiceActionAssociationErrorCode

	// A text description of the error.
	ErrorMessage *string

	// The product identifier. For example, prod-abcdzk7xy33qa .
	ProductId *string

	// The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
	ProvisioningArtifactId *string

	// The self-service action identifier. For example, act-fs7abcd89wxyz .
	ServiceActionId *string
	// contains filtered or unexported fields
}

An object containing information about the error, along with identifying information about the self-service action and its associations.

type InvalidParametersException 

type InvalidParametersException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more parameters provided to the operation are not valid.

func (*InvalidParametersException) Error 

func (e *InvalidParametersException) Error() string

func (*InvalidParametersException) ErrorCode 

func (e *InvalidParametersException) ErrorCode() string

func (*InvalidParametersException) ErrorFault 

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

func (*InvalidParametersException) ErrorMessage 

func (e *InvalidParametersException) ErrorMessage() string

type InvalidStateException 

type InvalidStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

func (*InvalidStateException) Error 

func (e *InvalidStateException) Error() string

func (*InvalidStateException) ErrorCode 

func (e *InvalidStateException) ErrorCode() string

func (*InvalidStateException) ErrorFault 

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

func (*InvalidStateException) ErrorMessage 

func (e *InvalidStateException) ErrorMessage() string

type LastSync added in v1.15.0 

type LastSync struct {

	// The ProvisioningArtifactID of the ProvisioningArtifact created from the latest
	// successful sync.
	LastSuccessfulSyncProvisioningArtifactId *string

	// The time of the latest successful sync from the source repo artifact to the
	// Service Catalog product.
	LastSuccessfulSyncTime *time.Time

	// The current status of the sync. Responses include SUCCEEDED or FAILED .
	LastSyncStatus LastSyncStatus

	// The sync's status message.
	LastSyncStatusMessage *string

	// The time of the last attempted sync from the repository to the Service Catalog
	// product.
	LastSyncTime *time.Time
	// contains filtered or unexported fields
}

Provides details about the product's connection sync and contains the following sub-fields.

  • LastSyncTime
  • LastSyncStatus
  • LastSyncStatusMessage
  • LastSuccessfulSyncTime
  • LastSuccessfulSyncProvisioningArtifactID

type LastSyncStatus added in v1.15.0 

type LastSyncStatus string
const (
	LastSyncStatusSucceeded LastSyncStatus = "SUCCEEDED"
	LastSyncStatusFailed    LastSyncStatus = "FAILED"
)

Enum values for LastSyncStatus

func (LastSyncStatus) Values added in v1.15.0 

func (LastSyncStatus) Values() []LastSyncStatus

Values returns all known values for LastSyncStatus. 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 LaunchPath 

type LaunchPath struct {

	// The identifier of the launch path.
	Id *string

	// The name of the launch path.
	Name *string
	// contains filtered or unexported fields
}

A launch path object.

type LaunchPathSummary 

type LaunchPathSummary struct {

	// The constraints on the portfolio-product relationship.
	ConstraintSummaries []ConstraintSummary

	// The identifier of the product path.
	Id *string

	// The name of the portfolio that contains the product.
	Name *string

	// The tags associated with this product path.
	Tags []Tag
	// contains filtered or unexported fields
}

Summary information about a product path for a user.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type ListRecordHistorySearchFilter 

type ListRecordHistorySearchFilter struct {

	// The filter key.
	//   - product - Filter results based on the specified product identifier.
	//   - provisionedproduct - Filter results based on the provisioned product
	//   identifier.
	Key *string

	// The filter value.
	Value *string
	// contains filtered or unexported fields
}

The search filter to use when listing history records.

type ListTagOptionsFilters 

type ListTagOptionsFilters struct {

	// The active state.
	Active *bool

	// The TagOption key.
	Key *string

	// The TagOption value.
	Value *string
	// contains filtered or unexported fields
}

Filters to use when listing TagOptions.

type OperationNotSupportedException 

type OperationNotSupportedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation is not supported.

func (*OperationNotSupportedException) Error 

func (e *OperationNotSupportedException) Error() string

func (*OperationNotSupportedException) ErrorCode 

func (e *OperationNotSupportedException) ErrorCode() string

func (*OperationNotSupportedException) ErrorFault 

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

func (*OperationNotSupportedException) ErrorMessage 

func (e *OperationNotSupportedException) ErrorMessage() string

type OrganizationNode 

type OrganizationNode struct {

	// The organization node type.
	Type OrganizationNodeType

	// The identifier of the organization node.
	Value *string
	// contains filtered or unexported fields
}

Information about the organization node.

type OrganizationNodeType 

type OrganizationNodeType string
const (
	OrganizationNodeTypeOrganization       OrganizationNodeType = "ORGANIZATION"
	OrganizationNodeTypeOrganizationalUnit OrganizationNodeType = "ORGANIZATIONAL_UNIT"
	OrganizationNodeTypeAccount            OrganizationNodeType = "ACCOUNT"
)

Enum values for OrganizationNodeType

func (OrganizationNodeType) Values added in v0.29.0 

func (OrganizationNodeType) Values() []OrganizationNodeType

Values returns all known values for OrganizationNodeType. 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 ParameterConstraints 

type ParameterConstraints struct {

	// A regular expression that represents the patterns that allow for String types.
	// The pattern must match the entire parameter value provided.
	AllowedPattern *string

	// The values that the administrator has allowed for the parameter.
	AllowedValues []string

	// A string that explains a constraint when the constraint is violated. For
	// example, without a constraint description, a parameter that has an allowed
	// pattern of [A-Za-z0-9]+ displays the following error message when the user
	// specifies an invalid value: Malformed input-Parameter MyParameter must match
	// pattern [A-Za-z0-9]+ By adding a constraint description, such as must only
	// contain letters (uppercase and lowercase) and numbers, you can display the
	// following customized error message: Malformed input-Parameter MyParameter must
	// only contain uppercase and lowercase letters and numbers.
	ConstraintDescription *string

	// An integer value that determines the largest number of characters you want to
	// allow for String types.
	MaxLength *string

	// A numeric value that determines the largest numeric value you want to allow for
	// Number types.
	MaxValue *string

	// An integer value that determines the smallest number of characters you want to
	// allow for String types.
	MinLength *string

	// A numeric value that determines the smallest numeric value you want to allow
	// for Number types.
	MinValue *string
	// contains filtered or unexported fields
}

The constraints that the administrator has put on the parameter.

type PortfolioDetail 

type PortfolioDetail struct {

	// The ARN assigned to the portfolio.
	ARN *string

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The description of the portfolio.
	Description *string

	// The name to use for display purposes.
	DisplayName *string

	// The portfolio identifier.
	Id *string

	// The name of the portfolio provider.
	ProviderName *string
	// contains filtered or unexported fields
}

Information about a portfolio.

type PortfolioShareDetail added in v0.31.0 

type PortfolioShareDetail struct {

	// Indicates whether the shared portfolio is imported by the recipient account. If
	// the recipient is in an organization node, the share is automatically imported,
	// and the field is always set to true.
	Accepted bool

	// The identifier of the recipient entity that received the portfolio share. The
	// recipient entity can be one of the following: 1. An external account. 2. An
	// organziation member account. 3. An organzational unit (OU). 4. The organization
	// itself. (This shares with every account in the organization).
	PrincipalId *string

	// Indicates if Principal sharing is enabled or disabled for the portfolio share.
	SharePrincipals bool

	// Indicates whether TagOptions sharing is enabled or disabled for the portfolio
	// share.
	ShareTagOptions bool

	// The type of the portfolio share.
	Type DescribePortfolioShareType
	// contains filtered or unexported fields
}

Information about the portfolio share.

type PortfolioShareType 

type PortfolioShareType string
const (
	PortfolioShareTypeImported          PortfolioShareType = "IMPORTED"
	PortfolioShareTypeAwsServicecatalog PortfolioShareType = "AWS_SERVICECATALOG"
	PortfolioShareTypeAwsOrganizations  PortfolioShareType = "AWS_ORGANIZATIONS"
)

Enum values for PortfolioShareType

func (PortfolioShareType) Values added in v0.29.0 

func (PortfolioShareType) Values() []PortfolioShareType

Values returns all known values for PortfolioShareType. 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 Principal 

type Principal struct {

	// The ARN of the principal (user, role, or group). This field allows for an ARN
	// with no accountID , with or without wildcard characters if the PrincipalType is
	// an IAM_PATTERN . For more information, review associate-principal-with-portfolio (https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options)
	// in the Amazon Web Services CLI Command Reference.
	PrincipalARN *string

	// The principal type. The supported value is IAM if you use a fully defined ARN,
	// or IAM_PATTERN if you use an ARN with no accountID , with or without wildcard
	// characters.
	PrincipalType PrincipalType
	// contains filtered or unexported fields
}

Information about a principal.

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeIam        PrincipalType = "IAM"
	PrincipalTypeIamPattern PrincipalType = "IAM_PATTERN"
)

Enum values for PrincipalType

func (PrincipalType) Values added in v0.29.0 

func (PrincipalType) Values() []PrincipalType

Values returns all known values for PrincipalType. 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 ProductSource 

type ProductSource string
const (
	ProductSourceAccount ProductSource = "ACCOUNT"
)

Enum values for ProductSource

func (ProductSource) Values added in v0.29.0 

func (ProductSource) Values() []ProductSource

Values returns all known values for ProductSource. 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 ProductType 

type ProductType string
const (
	ProductTypeCloudFormationTemplate ProductType = "CLOUD_FORMATION_TEMPLATE"
	ProductTypeMarketplace            ProductType = "MARKETPLACE"
	ProductTypeTerraformOpenSource    ProductType = "TERRAFORM_OPEN_SOURCE"
	ProductTypeTerraformCloud         ProductType = "TERRAFORM_CLOUD"
	ProductTypeExternal               ProductType = "EXTERNAL"
)

Enum values for ProductType

func (ProductType) Values added in v0.29.0 

func (ProductType) Values() []ProductType

Values returns all known values for ProductType. 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 ProductViewAggregationValue 

type ProductViewAggregationValue struct {

	// An approximate count of the products that match the value.
	ApproximateCount int32

	// The value of the product view aggregation.
	Value *string
	// contains filtered or unexported fields
}

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

type ProductViewDetail 

type ProductViewDetail struct {

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The ARN of the product.
	ProductARN *string

	// Summary information about the product view.
	ProductViewSummary *ProductViewSummary

	// A top level ProductViewDetail response containing details about the product’s
	// connection. Service Catalog returns this field for the CreateProduct ,
	// UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This
	// response contains the same fields as the ConnectionParameters request, with the
	// addition of the LastSync response.
	SourceConnection *SourceConnectionDetail

	// The status of the product.
	//   - AVAILABLE - The product is ready for use.
	//   - CREATING - Product creation has started; the product is not ready for use.
	//   - FAILED - An action failed.
	Status Status
	// contains filtered or unexported fields
}

Information about a product view.

type ProductViewFilterBy 

type ProductViewFilterBy string
const (
	ProductViewFilterByFullTextSearch  ProductViewFilterBy = "FullTextSearch"
	ProductViewFilterByOwner           ProductViewFilterBy = "Owner"
	ProductViewFilterByProductType     ProductViewFilterBy = "ProductType"
	ProductViewFilterBySourceProductId ProductViewFilterBy = "SourceProductId"
)

Enum values for ProductViewFilterBy

func (ProductViewFilterBy) Values added in v0.29.0 

func (ProductViewFilterBy) Values() []ProductViewFilterBy

Values returns all known values for ProductViewFilterBy. 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 ProductViewSortBy 

type ProductViewSortBy string
const (
	ProductViewSortByTitle        ProductViewSortBy = "Title"
	ProductViewSortByVersionCount ProductViewSortBy = "VersionCount"
	ProductViewSortByCreationDate ProductViewSortBy = "CreationDate"
)

Enum values for ProductViewSortBy

func (ProductViewSortBy) Values added in v0.29.0 

func (ProductViewSortBy) Values() []ProductViewSortBy

Values returns all known values for ProductViewSortBy. 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 ProductViewSummary 

type ProductViewSummary struct {

	// The distributor of the product. Contact the product administrator for the
	// significance of this value.
	Distributor *string

	// Indicates whether the product has a default path. If the product does not have
	// a default path, call ListLaunchPaths to disambiguate between paths. Otherwise,
	// ListLaunchPaths is not required, and the output of ProductViewSummary can be
	// used directly with DescribeProvisioningParameters .
	HasDefaultPath bool

	// The product view identifier.
	Id *string

	// The name of the product.
	Name *string

	// The owner of the product. Contact the product administrator for the
	// significance of this value.
	Owner *string

	// The product identifier.
	ProductId *string

	// Short description of the product.
	ShortDescription *string

	// The description of the support for this Product.
	SupportDescription *string

	// The email contact information to obtain support for this Product.
	SupportEmail *string

	// The URL information to obtain support for this Product.
	SupportUrl *string

	// The product type. Contact the product administrator for the significance of
	// this value. If this value is MARKETPLACE , the product was created by Amazon Web
	// Services Marketplace.
	Type ProductType
	// contains filtered or unexported fields
}

Summary information about a product view.

type PropertyKey 

type PropertyKey string
const (
	PropertyKeyOwner      PropertyKey = "OWNER"
	PropertyKeyLaunchRole PropertyKey = "LAUNCH_ROLE"
)

Enum values for PropertyKey

func (PropertyKey) Values added in v0.29.0 

func (PropertyKey) Values() []PropertyKey

Values returns all known values for PropertyKey. 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 ProvisionedProductAttribute 

type ProvisionedProductAttribute struct {

	// The ARN of the provisioned product.
	Arn *string

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The identifier of the provisioned product.
	Id *string

	// A unique identifier that you provide to ensure idempotency. If multiple
	// requests differ only by the idempotency token, the same response is returned for
	// each repeated request.
	IdempotencyToken *string

	// The record identifier of the last request performed on this provisioned product
	// of the following types:
	//   - ProvisionProduct
	//   - UpdateProvisionedProduct
	//   - ExecuteProvisionedProductPlan
	//   - TerminateProvisionedProduct
	LastProvisioningRecordId *string

	// The record identifier of the last request performed on this provisioned product.
	LastRecordId *string

	// The record identifier of the last successful request performed on this
	// provisioned product of the following types:
	//   - ProvisionProduct
	//   - UpdateProvisionedProduct
	//   - ExecuteProvisionedProductPlan
	//   - TerminateProvisionedProduct
	LastSuccessfulProvisioningRecordId *string

	// The user-friendly name of the provisioned product.
	Name *string

	// The assigned identifier for the resource, such as an EC2 instance ID or an S3
	// bucket name.
	PhysicalId *string

	// The product identifier.
	ProductId *string

	// The name of the product.
	ProductName *string

	// The identifier of the provisioning artifact.
	ProvisioningArtifactId *string

	// The name of the provisioning artifact.
	ProvisioningArtifactName *string

	// The current status of the provisioned product.
	//   - AVAILABLE - Stable state, ready to perform any operation. The most recent
	//   operation succeeded and completed.
	//   - UNDER_CHANGE - Transitive state. Operations performed might not have valid
	//   results. Wait for an AVAILABLE status before performing operations.
	//   - TAINTED - Stable state, ready to perform any operation. The stack has
	//   completed the requested operation but is not exactly what was requested. For
	//   example, a request to update to a new version failed and the stack rolled back
	//   to the current version.
	//   - ERROR - An unexpected error occurred. The provisioned product exists but the
	//   stack is not running. For example, CloudFormation received a parameter value
	//   that was not valid and could not launch the stack.
	//   - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to
	//   provision a new product, but resources have not yet been created. After
	//   reviewing the list of resources to be created, execute the plan. Wait for an
	//   AVAILABLE status before performing operations.
	Status ProvisionedProductStatus

	// The current status message of the provisioned product.
	StatusMessage *string

	// One or more tags.
	Tags []Tag

	// The type of provisioned product. The supported values are CFN_STACK ,
	// CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD , and EXTERNAL .
	Type *string

	// The Amazon Resource Name (ARN) of the user.
	UserArn *string

	// The ARN of the user in the session. This ARN might contain a session ID.
	UserArnSession *string
	// contains filtered or unexported fields
}

Information about a provisioned product.

type ProvisionedProductDetail 

type ProvisionedProductDetail struct {

	// The ARN of the provisioned product.
	Arn *string

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The identifier of the provisioned product.
	Id *string

	// A unique identifier that you provide to ensure idempotency. If multiple
	// requests differ only by the idempotency token, the same response is returned for
	// each repeated request.
	IdempotencyToken *string

	// The record identifier of the last request performed on this provisioned product
	// of the following types:
	//   - ProvisionProduct
	//   - UpdateProvisionedProduct
	//   - ExecuteProvisionedProductPlan
	//   - TerminateProvisionedProduct
	LastProvisioningRecordId *string

	// The record identifier of the last request performed on this provisioned product.
	LastRecordId *string

	// The record identifier of the last successful request performed on this
	// provisioned product of the following types:
	//   - ProvisionProduct
	//   - UpdateProvisionedProduct
	//   - ExecuteProvisionedProductPlan
	//   - TerminateProvisionedProduct
	LastSuccessfulProvisioningRecordId *string

	// The ARN of the launch role associated with the provisioned product.
	LaunchRoleArn *string

	// The user-friendly name of the provisioned product.
	Name *string

	// The product identifier. For example, prod-abcdzk7xy33qa .
	ProductId *string

	// The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
	ProvisioningArtifactId *string

	// The current status of the provisioned product.
	//   - AVAILABLE - Stable state, ready to perform any operation. The most recent
	//   operation succeeded and completed.
	//   - UNDER_CHANGE - Transitive state. Operations performed might not have valid
	//   results. Wait for an AVAILABLE status before performing operations.
	//   - TAINTED - Stable state, ready to perform any operation. The stack has
	//   completed the requested operation but is not exactly what was requested. For
	//   example, a request to update to a new version failed and the stack rolled back
	//   to the current version.
	//   - ERROR - An unexpected error occurred. The provisioned product exists but the
	//   stack is not running. For example, CloudFormation received a parameter value
	//   that was not valid and could not launch the stack.
	//   - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to
	//   provision a new product, but resources have not yet been created. After
	//   reviewing the list of resources to be created, execute the plan. Wait for an
	//   AVAILABLE status before performing operations.
	Status ProvisionedProductStatus

	// The current status message of the provisioned product.
	StatusMessage *string

	// The type of provisioned product. The supported values are CFN_STACK ,
	// CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD , and EXTERNAL .
	Type *string
	// contains filtered or unexported fields
}

Information about a provisioned product.

type ProvisionedProductPlanDetails 

type ProvisionedProductPlanDetails struct {

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
	// events.
	NotificationArns []string

	// The path identifier of the product. This value is optional if the product has a
	// default path, and required if the product has more than one path. To list the
	// paths for a product, use ListLaunchPaths .
	PathId *string

	// The plan identifier.
	PlanId *string

	// The name of the plan.
	PlanName *string

	// The plan type.
	PlanType ProvisionedProductPlanType

	// The product identifier.
	ProductId *string

	// The product identifier.
	ProvisionProductId *string

	// The user-friendly name of the provisioned product.
	ProvisionProductName *string

	// The identifier of the provisioning artifact.
	ProvisioningArtifactId *string

	// Parameters specified by the administrator that are required for provisioning
	// the product.
	ProvisioningParameters []UpdateProvisioningParameter

	// The status.
	Status ProvisionedProductPlanStatus

	// The status message.
	StatusMessage *string

	// One or more tags.
	Tags []Tag

	// The UTC time stamp when the plan was last updated.
	UpdatedTime *time.Time
	// contains filtered or unexported fields
}

Information about a plan.

type ProvisionedProductPlanStatus 

type ProvisionedProductPlanStatus string
const (
	ProvisionedProductPlanStatusCreateInProgress  ProvisionedProductPlanStatus = "CREATE_IN_PROGRESS"
	ProvisionedProductPlanStatusCreateSuccess     ProvisionedProductPlanStatus = "CREATE_SUCCESS"
	ProvisionedProductPlanStatusCreateFailed      ProvisionedProductPlanStatus = "CREATE_FAILED"
	ProvisionedProductPlanStatusExecuteInProgress ProvisionedProductPlanStatus = "EXECUTE_IN_PROGRESS"
	ProvisionedProductPlanStatusExecuteSuccess    ProvisionedProductPlanStatus = "EXECUTE_SUCCESS"
	ProvisionedProductPlanStatusExecuteFailed     ProvisionedProductPlanStatus = "EXECUTE_FAILED"
)

Enum values for ProvisionedProductPlanStatus

func (ProvisionedProductPlanStatus) Values added in v0.29.0 

func (ProvisionedProductPlanStatus) Values() []ProvisionedProductPlanStatus

Values returns all known values for ProvisionedProductPlanStatus. 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 ProvisionedProductPlanSummary 

type ProvisionedProductPlanSummary struct {

	// The plan identifier.
	PlanId *string

	// The name of the plan.
	PlanName *string

	// The plan type.
	PlanType ProvisionedProductPlanType

	// The product identifier.
	ProvisionProductId *string

	// The user-friendly name of the provisioned product.
	ProvisionProductName *string

	// The identifier of the provisioning artifact.
	ProvisioningArtifactId *string
	// contains filtered or unexported fields
}

Summary information about a plan.

type ProvisionedProductPlanType 

type ProvisionedProductPlanType string
const (
	ProvisionedProductPlanTypeCloudformation ProvisionedProductPlanType = "CLOUDFORMATION"
)

Enum values for ProvisionedProductPlanType

func (ProvisionedProductPlanType) Values added in v0.29.0 

func (ProvisionedProductPlanType) Values() []ProvisionedProductPlanType

Values returns all known values for ProvisionedProductPlanType. 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 ProvisionedProductStatus 

type ProvisionedProductStatus string
const (
	ProvisionedProductStatusAvailable      ProvisionedProductStatus = "AVAILABLE"
	ProvisionedProductStatusUnderChange    ProvisionedProductStatus = "UNDER_CHANGE"
	ProvisionedProductStatusTainted        ProvisionedProductStatus = "TAINTED"
	ProvisionedProductStatusError          ProvisionedProductStatus = "ERROR"
	ProvisionedProductStatusPlanInProgress ProvisionedProductStatus = "PLAN_IN_PROGRESS"
)

Enum values for ProvisionedProductStatus

func (ProvisionedProductStatus) Values added in v0.29.0 

func (ProvisionedProductStatus) Values() []ProvisionedProductStatus

Values returns all known values for ProvisionedProductStatus. 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 ProvisionedProductViewFilterBy 

type ProvisionedProductViewFilterBy string
const (
	ProvisionedProductViewFilterBySearchQuery ProvisionedProductViewFilterBy = "SearchQuery"
)

Enum values for ProvisionedProductViewFilterBy

func (ProvisionedProductViewFilterBy) Values added in v0.29.0 

func (ProvisionedProductViewFilterBy) Values() []ProvisionedProductViewFilterBy

Values returns all known values for ProvisionedProductViewFilterBy. 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 ProvisioningArtifact 

type ProvisioningArtifact struct {

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The description of the provisioning artifact.
	Description *string

	// Information set by the administrator to provide guidance to end users about
	// which provisioning artifacts to use.
	Guidance ProvisioningArtifactGuidance

	// The identifier of the provisioning artifact.
	Id *string

	// The name of the provisioning artifact.
	Name *string
	// contains filtered or unexported fields
}

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

type ProvisioningArtifactDetail 

type ProvisioningArtifactDetail struct {

	// Indicates whether the product version is active.
	Active *bool

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The description of the provisioning artifact.
	Description *string

	// Information set by the administrator to provide guidance to end users about
	// which provisioning artifacts to use.
	Guidance ProvisioningArtifactGuidance

	// The identifier of the provisioning artifact.
	Id *string

	// The name of the provisioning artifact.
	Name *string

	// Specifies the revision of the external artifact that was used to automatically
	// sync the Service Catalog product and create the provisioning artifact. Service
	// Catalog includes this response parameter as a high level field to the existing
	// ProvisioningArtifactDetail type, which is returned as part of the response for
	// CreateProduct , UpdateProduct , DescribeProductAsAdmin ,
	// DescribeProvisioningArtifact , ListProvisioningArtifact , and
	// UpdateProvisioningArticat APIs. This field only exists for Repo-Synced products.
	SourceRevision *string

	// The type of provisioning artifact.
	//   - CLOUD_FORMATION_TEMPLATE - CloudFormation template
	//   - TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
	//   - TERRAFORM_CLOUD - Terraform Cloud configuration file
	//   - EXTERNAL - External configuration file
	Type ProvisioningArtifactType
	// contains filtered or unexported fields
}

Information about a provisioning artifact (also known as a version) for a product.

type ProvisioningArtifactGuidance 

type ProvisioningArtifactGuidance string
const (
	ProvisioningArtifactGuidanceDefault    ProvisioningArtifactGuidance = "DEFAULT"
	ProvisioningArtifactGuidanceDeprecated ProvisioningArtifactGuidance = "DEPRECATED"
)

Enum values for ProvisioningArtifactGuidance

func (ProvisioningArtifactGuidance) Values added in v0.29.0 

func (ProvisioningArtifactGuidance) Values() []ProvisioningArtifactGuidance

Values returns all known values for ProvisioningArtifactGuidance. 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 ProvisioningArtifactOutput 

type ProvisioningArtifactOutput struct {

	// Description of the provisioning artifact output key.
	Description *string

	// The provisioning artifact output key.
	Key *string
	// contains filtered or unexported fields
}

Provisioning artifact output.

type ProvisioningArtifactParameter 

type ProvisioningArtifactParameter struct {

	// The default value.
	DefaultValue *string

	// The description of the parameter.
	Description *string

	// If this value is true, the value for this parameter is obfuscated from view
	// when the parameter is retrieved. This parameter is used to hide sensitive
	// information.
	IsNoEcho bool

	// Constraints that the administrator has put on a parameter.
	ParameterConstraints *ParameterConstraints

	// The parameter key.
	ParameterKey *string

	// The parameter type.
	ParameterType *string
	// contains filtered or unexported fields
}

Information about a parameter used to provision a product.

type ProvisioningArtifactPreferences 

type ProvisioningArtifactPreferences struct {

	// One or more Amazon Web Services accounts where stack instances are deployed
	// from the stack set. These accounts can be scoped in
	// ProvisioningPreferences$StackSetAccounts and
	// UpdateProvisioningPreferences$StackSetAccounts . Applicable only to a
	// CFN_STACKSET provisioned product type.
	StackSetAccounts []string

	// One or more Amazon Web Services Regions where stack instances are deployed from
	// the stack set. These Regions can be scoped in
	// ProvisioningPreferences$StackSetRegions and
	// UpdateProvisioningPreferences$StackSetRegions . Applicable only to a
	// CFN_STACKSET provisioned product type.
	StackSetRegions []string
	// contains filtered or unexported fields
}

The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences . For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) in the CloudFormation User Guide.

type ProvisioningArtifactProperties 

type ProvisioningArtifactProperties struct {

	// The description of the provisioning artifact, including how it differs from the
	// previous provisioning artifact.
	Description *string

	// If set to true, Service Catalog stops validating the specified provisioning
	// artifact even if it is invalid. Service Catalog does not support template
	// validation for the TERRAFORM_OS product type.
	DisableTemplateValidation bool

	// Specify the template source with one of the following options, but not both.
	// Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ] The URL of the
	// CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL
	// in JSON format as follows: "LoadTemplateFromURL":
	// "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
	// ImportFromPhysicalId : The physical id of the resource that contains the
	// template. Currently only supports CloudFormation stack arn. Specify the physical
	// id in JSON format as follows: ImportFromPhysicalId:
	// “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
	Info map[string]string

	// The name of the provisioning artifact (for example, v1 v2beta). No spaces are
	// allowed.
	Name *string

	// The type of provisioning artifact.
	//   - CLOUD_FORMATION_TEMPLATE - CloudFormation template
	//   - TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
	//   - TERRAFORM_CLOUD - Terraform Cloud configuration file
	//   - EXTERNAL - External configuration file
	Type ProvisioningArtifactType
	// contains filtered or unexported fields
}

Information about a provisioning artifact (also known as a version) for a product.

type ProvisioningArtifactPropertyName 

type ProvisioningArtifactPropertyName string
const (
	ProvisioningArtifactPropertyNameId ProvisioningArtifactPropertyName = "Id"
)

Enum values for ProvisioningArtifactPropertyName

func (ProvisioningArtifactPropertyName) Values added in v0.29.0 

func (ProvisioningArtifactPropertyName) Values() []ProvisioningArtifactPropertyName

Values returns all known values for ProvisioningArtifactPropertyName. 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 ProvisioningArtifactSummary 

type ProvisioningArtifactSummary struct {

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The description of the provisioning artifact.
	Description *string

	// The identifier of the provisioning artifact.
	Id *string

	// The name of the provisioning artifact.
	Name *string

	// The metadata for the provisioning artifact. This is used with Amazon Web
	// Services Marketplace products.
	ProvisioningArtifactMetadata map[string]string
	// contains filtered or unexported fields
}

Summary information about a provisioning artifact (also known as a version) for a product.

type ProvisioningArtifactType 

type ProvisioningArtifactType string
const (
	ProvisioningArtifactTypeCloudFormationTemplate ProvisioningArtifactType = "CLOUD_FORMATION_TEMPLATE"
	ProvisioningArtifactTypeMarketplaceAmi         ProvisioningArtifactType = "MARKETPLACE_AMI"
	ProvisioningArtifactTypeMarketplaceCar         ProvisioningArtifactType = "MARKETPLACE_CAR"
	ProvisioningArtifactTypeTerraformOpenSource    ProvisioningArtifactType = "TERRAFORM_OPEN_SOURCE"
	ProvisioningArtifactTypeTerraformCloud         ProvisioningArtifactType = "TERRAFORM_CLOUD"
	ProvisioningArtifactTypeExternal               ProvisioningArtifactType = "EXTERNAL"
)

Enum values for ProvisioningArtifactType

func (ProvisioningArtifactType) Values added in v0.29.0 

func (ProvisioningArtifactType) Values() []ProvisioningArtifactType

Values returns all known values for ProvisioningArtifactType. 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 ProvisioningArtifactView 

type ProvisioningArtifactView struct {

	// Summary information about a product view.
	ProductViewSummary *ProductViewSummary

	// Information about a provisioning artifact. A provisioning artifact is also
	// known as a product version.
	ProvisioningArtifact *ProvisioningArtifact
	// contains filtered or unexported fields
}

An object that contains summary information about a product view and a provisioning artifact.

type ProvisioningParameter 

type ProvisioningParameter struct {

	// The parameter key.
	Key *string

	// The parameter value.
	Value *string
	// contains filtered or unexported fields
}

Information about a parameter used to provision a product.

type ProvisioningPreferences 

type ProvisioningPreferences struct {

	// One or more Amazon Web Services accounts where the provisioned product will be
	// available. Applicable only to a CFN_STACKSET provisioned product type. The
	// specified accounts should be within the list of accounts from the STACKSET
	// constraint. To get the list of accounts in the STACKSET constraint, use the
	// DescribeProvisioningParameters operation. If no values are specified, the
	// default value is all acounts from the STACKSET constraint.
	StackSetAccounts []string

	// The number of accounts, per Region, for which this operation can fail before
	// Service Catalog stops the operation in that Region. If the operation is stopped
	// in a Region, Service Catalog doesn't attempt the operation in any subsequent
	// Regions. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetFailureToleranceCount or
	// StackSetFailureTolerancePercentage , but not both. The default value is 0 if no
	// value is specified.
	StackSetFailureToleranceCount *int32

	// The percentage of accounts, per Region, for which this stack operation can fail
	// before Service Catalog stops the operation in that Region. If the operation is
	// stopped in a Region, Service Catalog doesn't attempt the operation in any
	// subsequent Regions. When calculating the number of accounts based on the
	// specified percentage, Service Catalog rounds down to the next whole number.
	// Applicable only to a CFN_STACKSET provisioned product type. Conditional: You
	// must specify either StackSetFailureToleranceCount or
	// StackSetFailureTolerancePercentage , but not both.
	StackSetFailureTolerancePercentage *int32

	// The maximum number of accounts in which to perform this operation at one time.
	// This is dependent on the value of StackSetFailureToleranceCount .
	// StackSetMaxConcurrentCount is at most one more than the
	// StackSetFailureToleranceCount . Note that this setting lets you specify the
	// maximum for operations. For large deployments, under certain circumstances the
	// actual number of accounts acted upon concurrently may be lower due to service
	// throttling. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetMaxConcurrentCount or
	// StackSetMaxConcurrentPercentage , but not both.
	StackSetMaxConcurrencyCount *int32

	// The maximum percentage of accounts in which to perform this operation at one
	// time. When calculating the number of accounts based on the specified percentage,
	// Service Catalog rounds down to the next whole number. This is true except in
	// cases where rounding down would result is zero. In this case, Service Catalog
	// sets the number as 1 instead. Note that this setting lets you specify the
	// maximum for operations. For large deployments, under certain circumstances the
	// actual number of accounts acted upon concurrently may be lower due to service
	// throttling. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetMaxConcurrentCount or
	// StackSetMaxConcurrentPercentage , but not both.
	StackSetMaxConcurrencyPercentage *int32

	// One or more Amazon Web Services Regions where the provisioned product will be
	// available. Applicable only to a CFN_STACKSET provisioned product type. The
	// specified Regions should be within the list of Regions from the STACKSET
	// constraint. To get the list of Regions in the STACKSET constraint, use the
	// DescribeProvisioningParameters operation. If no values are specified, the
	// default value is all Regions from the STACKSET constraint.
	StackSetRegions []string
	// contains filtered or unexported fields
}

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type One or more Amazon Web Services accounts that will have access to the provisioned product. Applicable only to a CFN_STACKSET provisioned product type. The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all accounts from the STACKSET constraint.

type RecordDetail 

type RecordDetail struct {

	// The UTC time stamp of the creation time.
	CreatedTime *time.Time

	// The ARN of the launch role associated with the provisioned product.
	LaunchRoleArn *string

	// The path identifier.
	PathId *string

	// The product identifier.
	ProductId *string

	// The identifier of the provisioned product.
	ProvisionedProductId *string

	// The user-friendly name of the provisioned product.
	ProvisionedProductName *string

	// The type of provisioned product. The supported values are CFN_STACK ,
	// CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD , and EXTERNAL .
	ProvisionedProductType *string

	// The identifier of the provisioning artifact.
	ProvisioningArtifactId *string

	// The errors that occurred.
	RecordErrors []RecordError

	// The identifier of the record.
	RecordId *string

	// One or more tags.
	RecordTags []RecordTag

	// The record type.
	//   - PROVISION_PRODUCT
	//   - UPDATE_PROVISIONED_PRODUCT
	//   - TERMINATE_PROVISIONED_PRODUCT
	RecordType *string

	// The status of the provisioned product.
	//   - CREATED - The request was created but the operation has not started.
	//   - IN_PROGRESS - The requested operation is in progress.
	//   - IN_PROGRESS_IN_ERROR - The provisioned product is under change but the
	//   requested operation failed and some remediation is occurring. For example, a
	//   rollback.
	//   - SUCCEEDED - The requested operation has successfully completed.
	//   - FAILED - The requested operation has unsuccessfully completed. Investigate
	//   using the error messages returned.
	Status RecordStatus

	// The time when the record was last updated.
	UpdatedTime *time.Time
	// contains filtered or unexported fields
}

Information about a request operation.

type RecordError 

type RecordError struct {

	// The numeric value of the error.
	Code *string

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

The error code and description resulting from an operation.

type RecordOutput 

type RecordOutput struct {

	// The description of the output.
	Description *string

	// The output key.
	OutputKey *string

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

The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

type RecordStatus 

type RecordStatus string
const (
	RecordStatusCreated           RecordStatus = "CREATED"
	RecordStatusInProgress        RecordStatus = "IN_PROGRESS"
	RecordStatusInProgressInError RecordStatus = "IN_PROGRESS_IN_ERROR"
	RecordStatusSucceeded         RecordStatus = "SUCCEEDED"
	RecordStatusFailed            RecordStatus = "FAILED"
)

Enum values for RecordStatus

func (RecordStatus) Values added in v0.29.0 

func (RecordStatus) Values() []RecordStatus

Values returns all known values for RecordStatus. 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 RecordTag 

type RecordTag struct {

	// The key for this tag.
	Key *string

	// The value for this tag.
	Value *string
	// contains filtered or unexported fields
}

Information about a tag, which is a key-value pair.

type Replacement 

type Replacement string
const (
	ReplacementTrue        Replacement = "TRUE"
	ReplacementFalse       Replacement = "FALSE"
	ReplacementConditional Replacement = "CONDITIONAL"
)

Enum values for Replacement

func (Replacement) Values added in v0.29.0 

func (Replacement) Values() []Replacement

Values returns all known values for Replacement. 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 RequiresRecreation 

type RequiresRecreation string
const (
	RequiresRecreationNever         RequiresRecreation = "NEVER"
	RequiresRecreationConditionally RequiresRecreation = "CONDITIONALLY"
	RequiresRecreationAlways        RequiresRecreation = "ALWAYS"
)

Enum values for RequiresRecreation

func (RequiresRecreation) Values added in v0.29.0 

func (RequiresRecreation) Values() []RequiresRecreation

Values returns all known values for RequiresRecreation. 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 ResourceAttribute 

type ResourceAttribute string
const (
	ResourceAttributeProperties     ResourceAttribute = "PROPERTIES"
	ResourceAttributeMetadata       ResourceAttribute = "METADATA"
	ResourceAttributeCreationpolicy ResourceAttribute = "CREATIONPOLICY"
	ResourceAttributeUpdatepolicy   ResourceAttribute = "UPDATEPOLICY"
	ResourceAttributeDeletionpolicy ResourceAttribute = "DELETIONPOLICY"
	ResourceAttributeTags           ResourceAttribute = "TAGS"
)

Enum values for ResourceAttribute

func (ResourceAttribute) Values added in v0.29.0 

func (ResourceAttribute) Values() []ResourceAttribute

Values returns all known values for ResourceAttribute. 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 ResourceChange 

type ResourceChange struct {

	// The change action.
	Action ChangeAction

	// Information about the resource changes.
	Details []ResourceChangeDetail

	// The ID of the resource, as defined in the CloudFormation template.
	LogicalResourceId *string

	// The ID of the resource, if it was already created.
	PhysicalResourceId *string

	// If the change type is Modify , indicates whether the existing resource is
	// deleted and replaced with a new one.
	Replacement Replacement

	// The type of resource.
	ResourceType *string

	// The change scope.
	Scope []ResourceAttribute
	// contains filtered or unexported fields
}

Information about a resource change that will occur when a plan is executed.

type ResourceChangeDetail 

type ResourceChangeDetail struct {

	// The ID of the entity that caused the change.
	CausingEntity *string

	// For static evaluations, the value of the resource attribute will change and the
	// new value is known. For dynamic evaluations, the value might change, and any new
	// value will be determined when the plan is updated.
	Evaluation EvaluationType

	// Information about the resource attribute to be modified.
	Target *ResourceTargetDefinition
	// contains filtered or unexported fields
}

Information about a change to a resource attribute.

type ResourceDetail 

type ResourceDetail struct {

	// The ARN of the resource.
	ARN *string

	// The creation time of the resource.
	CreatedTime *time.Time

	// The description of the resource.
	Description *string

	// The identifier of the resource.
	Id *string

	// The name of the resource.
	Name *string
	// contains filtered or unexported fields
}

Information about a resource.

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

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

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource was not 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 ResourceTargetDefinition 

type ResourceTargetDefinition struct {

	// The attribute to be changed.
	Attribute ResourceAttribute

	// If the attribute is Properties , the value is the name of the property.
	// Otherwise, the value is null.
	Name *string

	// If the attribute is Properties , indicates whether a change to this property
	// causes the resource to be re-created.
	RequiresRecreation RequiresRecreation
	// contains filtered or unexported fields
}

Information about a change to a resource attribute.

type ServiceActionAssociation 

type ServiceActionAssociation struct {

	// The product identifier. For example, prod-abcdzk7xy33qa .
	//
	// This member is required.
	ProductId *string

	// The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
	//
	// This member is required.
	ProvisioningArtifactId *string

	// The self-service action identifier. For example, act-fs7abcd89wxyz .
	//
	// This member is required.
	ServiceActionId *string
	// contains filtered or unexported fields
}

A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

type ServiceActionAssociationErrorCode 

type ServiceActionAssociationErrorCode string
const (
	ServiceActionAssociationErrorCodeDuplicateResourceException ServiceActionAssociationErrorCode = "DUPLICATE_RESOURCE"
	ServiceActionAssociationErrorCodeInternalFailure            ServiceActionAssociationErrorCode = "INTERNAL_FAILURE"
	ServiceActionAssociationErrorCodeLimitExceededException     ServiceActionAssociationErrorCode = "LIMIT_EXCEEDED"
	ServiceActionAssociationErrorCodeResourceNotFoundException  ServiceActionAssociationErrorCode = "RESOURCE_NOT_FOUND"
	ServiceActionAssociationErrorCodeThrottlingException        ServiceActionAssociationErrorCode = "THROTTLING"
	ServiceActionAssociationErrorCodeInvalidParameterException  ServiceActionAssociationErrorCode = "INVALID_PARAMETER"
)

Enum values for ServiceActionAssociationErrorCode

func (ServiceActionAssociationErrorCode) Values added in v0.29.0 

func (ServiceActionAssociationErrorCode) Values() []ServiceActionAssociationErrorCode

Values returns all known values for ServiceActionAssociationErrorCode. 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 ServiceActionDefinitionKey 

type ServiceActionDefinitionKey string
const (
	ServiceActionDefinitionKeyName       ServiceActionDefinitionKey = "Name"
	ServiceActionDefinitionKeyVersion    ServiceActionDefinitionKey = "Version"
	ServiceActionDefinitionKeyAssumeRole ServiceActionDefinitionKey = "AssumeRole"
	ServiceActionDefinitionKeyParameters ServiceActionDefinitionKey = "Parameters"
)

Enum values for ServiceActionDefinitionKey

func (ServiceActionDefinitionKey) Values added in v0.29.0 

func (ServiceActionDefinitionKey) Values() []ServiceActionDefinitionKey

Values returns all known values for ServiceActionDefinitionKey. 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 ServiceActionDefinitionType 

type ServiceActionDefinitionType string
const (
	ServiceActionDefinitionTypeSsmAutomation ServiceActionDefinitionType = "SSM_AUTOMATION"
)

Enum values for ServiceActionDefinitionType

func (ServiceActionDefinitionType) Values added in v0.29.0 

func (ServiceActionDefinitionType) Values() []ServiceActionDefinitionType

Values returns all known values for ServiceActionDefinitionType. 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 ServiceActionDetail 

type ServiceActionDetail struct {

	// A map that defines the self-service action.
	Definition map[string]string

	// Summary information about the self-service action.
	ServiceActionSummary *ServiceActionSummary
	// contains filtered or unexported fields
}

An object containing detailed information about the self-service action.

type ServiceActionSummary 

type ServiceActionSummary struct {

	// The self-service action definition type. For example, SSM_AUTOMATION .
	DefinitionType ServiceActionDefinitionType

	// The self-service action description.
	Description *string

	// The self-service action identifier.
	Id *string

	// The self-service action name.
	Name *string
	// contains filtered or unexported fields
}

Detailed information about the self-service action.

type ShareDetails 

type ShareDetails struct {

	// List of errors.
	ShareErrors []ShareError

	// List of accounts for whom the operation succeeded.
	SuccessfulShares []string
	// contains filtered or unexported fields
}

Information about the portfolio share operation.

type ShareError 

type ShareError struct {

	// List of accounts impacted by the error.
	Accounts []string

	// Error type that happened when processing the operation.
	Error *string

	// Information about the error.
	Message *string
	// contains filtered or unexported fields
}

Errors that occurred during the portfolio share operation.

type ShareStatus 

type ShareStatus string
const (
	ShareStatusNotStarted          ShareStatus = "NOT_STARTED"
	ShareStatusInProgress          ShareStatus = "IN_PROGRESS"
	ShareStatusCompleted           ShareStatus = "COMPLETED"
	ShareStatusCompletedWithErrors ShareStatus = "COMPLETED_WITH_ERRORS"
	ShareStatusError               ShareStatus = "ERROR"
)

Enum values for ShareStatus

func (ShareStatus) Values added in v0.29.0 

func (ShareStatus) Values() []ShareStatus

Values returns all known values for ShareStatus. 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 SortOrder 

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

Enum values for SortOrder

func (SortOrder) Values added in v0.29.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 SourceConnection added in v1.15.0 

type SourceConnection struct {

	// The connection details based on the connection Type .
	//
	// This member is required.
	ConnectionParameters *SourceConnectionParameters

	// The only supported SourceConnection type is Codestar.
	Type SourceType
	// contains filtered or unexported fields
}

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

type SourceConnectionDetail added in v1.15.0 

type SourceConnectionDetail struct {

	// The connection details based on the connection Type .
	ConnectionParameters *SourceConnectionParameters

	// Provides details about the product's connection sync and contains the following
	// sub-fields.
	//   - LastSyncTime
	//   - LastSyncStatus
	//   - LastSyncStatusMessage
	//   - LastSuccessfulSyncTime
	//   - LastSuccessfulSyncProvisioningArtifactID
	LastSync *LastSync

	// The only supported SourceConnection type is Codestar.
	Type SourceType
	// contains filtered or unexported fields
}

Provides details about the configured SourceConnection .

type SourceConnectionParameters added in v1.15.0 

type SourceConnectionParameters struct {

	// Provides ConnectionType details.
	CodeStar *CodeStarParameters
	// contains filtered or unexported fields
}

Provides connection details.

type SourceType added in v1.15.0 

type SourceType string
const (
	SourceTypeCodestar SourceType = "CODESTAR"
)

Enum values for SourceType

func (SourceType) Values added in v1.15.0 

func (SourceType) Values() []SourceType

Values returns all known values for SourceType. 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 StackInstance 

type StackInstance struct {

	// The name of the Amazon Web Services account that the stack instance is
	// associated with.
	Account *string

	// The name of the Amazon Web Services Region that the stack instance is
	// associated with.
	Region *string

	// The status of the stack instance, in terms of its synchronization with its
	// associated stack set.
	//   - INOPERABLE : A DeleteStackInstances operation has failed and left the stack
	//   in an unstable state. Stacks in this state are excluded from further
	//   UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//   operation, with RetainStacks set to true, to delete the stack instance, and
	//   then delete the stack manually.
	//   - OUTDATED : The stack isn't currently up to date with the stack set because
	//   either the associated stack failed during a CreateStackSet or UpdateStackSet
	//   operation, or the stack was part of a CreateStackSet or UpdateStackSet
	//   operation that failed or was stopped before the stack was created or updated.
	//   - CURRENT : The stack is currently up to date with the stack set.
	StackInstanceStatus StackInstanceStatus
	// contains filtered or unexported fields
}

An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

type StackInstanceStatus 

type StackInstanceStatus string
const (
	StackInstanceStatusCurrent    StackInstanceStatus = "CURRENT"
	StackInstanceStatusOutdated   StackInstanceStatus = "OUTDATED"
	StackInstanceStatusInoperable StackInstanceStatus = "INOPERABLE"
)

Enum values for StackInstanceStatus

func (StackInstanceStatus) Values added in v0.29.0 

func (StackInstanceStatus) Values() []StackInstanceStatus

Values returns all known values for StackInstanceStatus. 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 StackSetOperationType 

type StackSetOperationType string
const (
	StackSetOperationTypeCreate StackSetOperationType = "CREATE"
	StackSetOperationTypeUpdate StackSetOperationType = "UPDATE"
	StackSetOperationTypeDelete StackSetOperationType = "DELETE"
)

Enum values for StackSetOperationType

func (StackSetOperationType) Values added in v0.29.0 

func (StackSetOperationType) Values() []StackSetOperationType

Values returns all known values for StackSetOperationType. 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 Status 

type Status string
const (
	StatusAvailable Status = "AVAILABLE"
	StatusCreating  Status = "CREATING"
	StatusFailed    Status = "FAILED"
)

Enum values for Status

func (Status) Values added in v0.29.0 

func (Status) Values() []Status

Values returns all known values for Status. 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 tag key.
	//
	// This member is required.
	Key *string

	// The value for this key.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

type TagOptionDetail 

type TagOptionDetail struct {

	// The TagOption active state.
	Active *bool

	// The TagOption identifier.
	Id *string

	// The TagOption key.
	Key *string

	// The Amazon Web Services account Id of the owner account that created the
	// TagOption.
	Owner *string

	// The TagOption value.
	Value *string
	// contains filtered or unexported fields
}

Information about a TagOption.

type TagOptionNotMigratedException 

type TagOptionNotMigratedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

func (*TagOptionNotMigratedException) Error 

func (e *TagOptionNotMigratedException) Error() string

func (*TagOptionNotMigratedException) ErrorCode 

func (e *TagOptionNotMigratedException) ErrorCode() string

func (*TagOptionNotMigratedException) ErrorFault 

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

func (*TagOptionNotMigratedException) ErrorMessage 

func (e *TagOptionNotMigratedException) ErrorMessage() string

type TagOptionSummary 

type TagOptionSummary struct {

	// The TagOption key.
	Key *string

	// The TagOption value.
	Values []string
	// contains filtered or unexported fields
}

Summary information about a TagOption.

type UniqueTagResourceIdentifier added in v1.17.0 

type UniqueTagResourceIdentifier struct {

	// A unique key that's attached to a resource.
	Key *string

	// A unique value that's attached to a resource.
	Value *string
	// contains filtered or unexported fields
}

The unique key-value pair for a tag that identifies provisioned product resources.

type UpdateProvisioningParameter 

type UpdateProvisioningParameter struct {

	// The parameter key.
	Key *string

	// If set to true, Value is ignored and the previous parameter value is kept.
	UsePreviousValue bool

	// The parameter value.
	Value *string
	// contains filtered or unexported fields
}

The parameter key-value pair used to update a provisioned product.

type UpdateProvisioningPreferences 

type UpdateProvisioningPreferences struct {

	// One or more Amazon Web Services accounts that will have access to the
	// provisioned product. Applicable only to a CFN_STACKSET provisioned product
	// type. The Amazon Web Services accounts specified should be within the list of
	// accounts in the STACKSET constraint. To get the list of accounts in the STACKSET
	// constraint, use the DescribeProvisioningParameters operation. If no values are
	// specified, the default value is all accounts from the STACKSET constraint.
	StackSetAccounts []string

	// The number of accounts, per Region, for which this operation can fail before
	// Service Catalog stops the operation in that Region. If the operation is stopped
	// in a Region, Service Catalog doesn't attempt the operation in any subsequent
	// Regions. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetFailureToleranceCount or
	// StackSetFailureTolerancePercentage , but not both. The default value is 0 if no
	// value is specified.
	StackSetFailureToleranceCount *int32

	// The percentage of accounts, per Region, for which this stack operation can fail
	// before Service Catalog stops the operation in that Region. If the operation is
	// stopped in a Region, Service Catalog doesn't attempt the operation in any
	// subsequent Regions. When calculating the number of accounts based on the
	// specified percentage, Service Catalog rounds down to the next whole number.
	// Applicable only to a CFN_STACKSET provisioned product type. Conditional: You
	// must specify either StackSetFailureToleranceCount or
	// StackSetFailureTolerancePercentage , but not both.
	StackSetFailureTolerancePercentage *int32

	// The maximum number of accounts in which to perform this operation at one time.
	// This is dependent on the value of StackSetFailureToleranceCount .
	// StackSetMaxConcurrentCount is at most one more than the
	// StackSetFailureToleranceCount . Note that this setting lets you specify the
	// maximum for operations. For large deployments, under certain circumstances the
	// actual number of accounts acted upon concurrently may be lower due to service
	// throttling. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetMaxConcurrentCount or
	// StackSetMaxConcurrentPercentage , but not both.
	StackSetMaxConcurrencyCount *int32

	// The maximum percentage of accounts in which to perform this operation at one
	// time. When calculating the number of accounts based on the specified percentage,
	// Service Catalog rounds down to the next whole number. This is true except in
	// cases where rounding down would result is zero. In this case, Service Catalog
	// sets the number as 1 instead. Note that this setting lets you specify the
	// maximum for operations. For large deployments, under certain circumstances the
	// actual number of accounts acted upon concurrently may be lower due to service
	// throttling. Applicable only to a CFN_STACKSET provisioned product type.
	// Conditional: You must specify either StackSetMaxConcurrentCount or
	// StackSetMaxConcurrentPercentage , but not both.
	StackSetMaxConcurrencyPercentage *int32

	// Determines what action Service Catalog performs to a stack set or a stack
	// instance represented by the provisioned product. The default value is UPDATE if
	// nothing is specified. Applicable only to a CFN_STACKSET provisioned product
	// type. CREATE Creates a new stack instance in the stack set represented by the
	// provisioned product. In this case, only new stack instances are created based on
	// accounts and Regions; if new ProductId or ProvisioningArtifactID are passed,
	// they will be ignored. UPDATE Updates the stack set represented by the
	// provisioned product and also its stack instances. DELETE Deletes a stack
	// instance in the stack set represented by the provisioned product.
	StackSetOperationType StackSetOperationType

	// One or more Amazon Web Services Regions where the provisioned product will be
	// available. Applicable only to a CFN_STACKSET provisioned product type. The
	// specified Regions should be within the list of Regions from the STACKSET
	// constraint. To get the list of Regions in the STACKSET constraint, use the
	// DescribeProvisioningParameters operation. If no values are specified, the
	// default value is all Regions from the STACKSET constraint.
	StackSetRegions []string
	// contains filtered or unexported fields
}

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

type UsageInstruction 

type UsageInstruction struct {

	// The usage instruction type for the value.
	Type *string

	// The usage instruction value for this type.
	Value *string
	// contains filtered or unexported fields
}

Additional information provided by the administrator.

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.