servicecatalog

package
v1.4.19 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package servicecatalog provides a client for AWS Service Catalog.

Index

Examples

Constants

View Source 
const (
	// AccessLevelFilterKeyAccount is a AccessLevelFilterKey enum value
	AccessLevelFilterKeyAccount = "Account"

	// AccessLevelFilterKeyRole is a AccessLevelFilterKey enum value
	AccessLevelFilterKeyRole = "Role"

	// AccessLevelFilterKeyUser is a AccessLevelFilterKey enum value
	AccessLevelFilterKeyUser = "User"
)
View Source 
const (
	// ProductViewFilterByFullTextSearch is a ProductViewFilterBy enum value
	ProductViewFilterByFullTextSearch = "FullTextSearch"

	// ProductViewFilterByOwner is a ProductViewFilterBy enum value
	ProductViewFilterByOwner = "Owner"

	// ProductViewFilterByProductType is a ProductViewFilterBy enum value
	ProductViewFilterByProductType = "ProductType"
)
View Source 
const (
	// ProductViewSortByTitle is a ProductViewSortBy enum value
	ProductViewSortByTitle = "Title"

	// ProductViewSortByVersionCount is a ProductViewSortBy enum value
	ProductViewSortByVersionCount = "VersionCount"

	// ProductViewSortByCreationDate is a ProductViewSortBy enum value
	ProductViewSortByCreationDate = "CreationDate"
)
View Source 
const (
	// RecordStatusInProgress is a RecordStatus enum value
	RecordStatusInProgress = "IN_PROGRESS"

	// RecordStatusSucceeded is a RecordStatus enum value
	RecordStatusSucceeded = "SUCCEEDED"

	// RecordStatusError is a RecordStatus enum value
	RecordStatusError = "ERROR"
)
View Source 
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
View Source 
const ServiceName = "servicecatalog"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessLevelFilter added in v1.4.9 

type AccessLevelFilter struct {

	// Specifies the access level.
	//
	//  Account allows results at the account level.
	//
	//  Role allows results based on the federated role of the specified user.
	//
	//  User allows results limited to the specified user.
	Key *string `type:"string" enum:"AccessLevelFilterKey"`

	// Specifies the user to which the access level applies. A value of Self is
	// currently supported.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The access level to limit results.

func (AccessLevelFilter) GoString added in v1.4.9 

func (s AccessLevelFilter) GoString() string

GoString returns the string representation

func (AccessLevelFilter) String added in v1.4.9 

func (s AccessLevelFilter) String() string

String returns the string representation

type ConstraintSummary 

type ConstraintSummary struct {

	// The text description of the constraint.
	Description *string `type:"string"`

	// The type of the constraint.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

An administrator-specified constraint to apply when provisioning a product.

func (ConstraintSummary) GoString 

func (s ConstraintSummary) GoString() string

GoString returns the string representation

func (ConstraintSummary) String 

func (s ConstraintSummary) String() string

String returns the string representation

type DescribeProductInput 

type DescribeProductInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The ProductId of the product to describe.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProductInput) GoString 

func (s DescribeProductInput) GoString() string

GoString returns the string representation

func (DescribeProductInput) String 

func (s DescribeProductInput) String() string

String returns the string representation

func (*DescribeProductInput) Validate 

func (s *DescribeProductInput) Validate() error

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

type DescribeProductOutput 

type DescribeProductOutput struct {

	// The summary metadata about the specified product.
	ProductViewSummary *ProductViewSummary `type:"structure"`

	// A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts
	// parameter represent the ways the specified product can be provisioned.
	ProvisioningArtifacts []*ProvisioningArtifact `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProductOutput) GoString 

func (s DescribeProductOutput) GoString() string

GoString returns the string representation

func (DescribeProductOutput) String 

func (s DescribeProductOutput) String() string

String returns the string representation

type DescribeProductViewInput 

type DescribeProductViewInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The ProductViewId of the product to describe.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProductViewInput) GoString 

func (s DescribeProductViewInput) GoString() string

GoString returns the string representation

func (DescribeProductViewInput) String 

func (s DescribeProductViewInput) String() string

String returns the string representation

func (*DescribeProductViewInput) Validate 

func (s *DescribeProductViewInput) Validate() error

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

type DescribeProductViewOutput 

type DescribeProductViewOutput struct {

	// The summary metadata about the specified product.
	ProductViewSummary *ProductViewSummary `type:"structure"`

	// A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts
	// represent the ways in which the specified product can be provisioned.
	ProvisioningArtifacts []*ProvisioningArtifact `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProductViewOutput) GoString 

func (s DescribeProductViewOutput) GoString() string

GoString returns the string representation

func (DescribeProductViewOutput) String 

func (s DescribeProductViewOutput) String() string

String returns the string representation

type DescribeProvisioningParametersInput 

type DescribeProvisioningParametersInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The identifier of the path for this product's provisioning. This value is
	// optional if the product has a default path, and is required if there is more
	// than one path for the specified product.
	PathId *string `min:"1" type:"string"`

	// The identifier of the product.
	//
	// ProductId is a required field
	ProductId *string `min:"1" type:"string" required:"true"`

	// The provisioning artifact identifier for this product.
	//
	// ProvisioningArtifactId is a required field
	ProvisioningArtifactId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningParametersInput) GoString 

func (s DescribeProvisioningParametersInput) GoString() string

GoString returns the string representation

func (DescribeProvisioningParametersInput) String 

func (s DescribeProvisioningParametersInput) String() string

String returns the string representation

func (*DescribeProvisioningParametersInput) Validate 

func (s *DescribeProvisioningParametersInput) Validate() error

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

type DescribeProvisioningParametersOutput 

type DescribeProvisioningParametersOutput struct {

	// The list of constraint summaries that apply to provisioning this product.
	ConstraintSummaries []*ConstraintSummary `type:"list"`

	// The list of parameters used to successfully provision the product. Each parameter
	// includes a list of allowable values and additional metadata about each parameter.
	ProvisioningArtifactParameters []*ProvisioningArtifactParameter `type:"list"`

	// Any additional metadata specifically related to the provisioning of the product.
	// For example, see the Version field of the CloudFormation template.
	UsageInstructions []*UsageInstruction `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeProvisioningParametersOutput) GoString 

func (s DescribeProvisioningParametersOutput) GoString() string

GoString returns the string representation

func (DescribeProvisioningParametersOutput) String 

func (s DescribeProvisioningParametersOutput) String() string

String returns the string representation

type DescribeRecordInput 

type DescribeRecordInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The record identifier of the ProvisionedProduct object for which to retrieve
	// output information. This is the RecordDetail.RecordId obtained from the request
	// operation's response.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The maximum number of items to return in the results. If more results exist
	// than fit in the specified PageSize, the value of NextPageToken in the response
	// is non-null.
	PageSize *int64 `type:"integer"`

	// The page token of the first page retrieved. If null, this retrieves the first
	// page of size PageSize.
	PageToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeRecordInput) GoString 

func (s DescribeRecordInput) GoString() string

GoString returns the string representation

func (DescribeRecordInput) String 

func (s DescribeRecordInput) String() string

String returns the string representation

func (*DescribeRecordInput) Validate 

func (s *DescribeRecordInput) Validate() error

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

type DescribeRecordOutput 

type DescribeRecordOutput struct {

	// The page token to use to retrieve the next page of results for this operation.
	// If there are no more pages, this value is null.
	NextPageToken *string `type:"string"`

	// Detailed record information for the specified product.
	RecordDetail *RecordDetail `type:"structure"`

	// A list of outputs for the specified Product object created as the result
	// of a request. For example, a CloudFormation-backed product that creates an
	// S3 bucket would have an output for the S3 bucket URL.
	RecordOutputs []*RecordOutput `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeRecordOutput) GoString 

func (s DescribeRecordOutput) GoString() string

GoString returns the string representation

func (DescribeRecordOutput) String 

func (s DescribeRecordOutput) String() string

String returns the string representation

type LaunchPathSummary 

type LaunchPathSummary struct {

	// List of constraints on the portfolio-product relationship.
	ConstraintSummaries []*ConstraintSummary `type:"list"`

	// The unique identifier of the product path.
	Id *string `min:"1" type:"string"`

	// Corresponds to the name of the portfolio to which the user was assigned.
	Name *string `type:"string"`

	// List of tags used by this launch path.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Summary information about a path for a user to have access to a specified product.

func (LaunchPathSummary) GoString 

func (s LaunchPathSummary) GoString() string

GoString returns the string representation

func (LaunchPathSummary) String 

func (s LaunchPathSummary) String() string

String returns the string representation

type ListLaunchPathsInput 

type ListLaunchPathsInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The maximum number of items to return in the results. If more results exist
	// than fit in the specified PageSize, the value of NextPageToken in the response
	// is non-null.
	PageSize *int64 `type:"integer"`

	// The page token of the first page retrieved. If null, this retrieves the first
	// page of size PageSize.
	PageToken *string `type:"string"`

	// Identifies the product for which to retrieve LaunchPathSummaries information.
	//
	// ProductId is a required field
	ProductId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListLaunchPathsInput) GoString 

func (s ListLaunchPathsInput) GoString() string

GoString returns the string representation

func (ListLaunchPathsInput) String 

func (s ListLaunchPathsInput) String() string

String returns the string representation

func (*ListLaunchPathsInput) Validate 

func (s *ListLaunchPathsInput) Validate() error

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

type ListLaunchPathsOutput 

type ListLaunchPathsOutput struct {

	// List of launch path information summaries for the specified PageToken.
	LaunchPathSummaries []*LaunchPathSummary `type:"list"`

	// The page token to use to retrieve the next page of results for this operation.
	// If there are no more pages, this value is null.
	NextPageToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLaunchPathsOutput) GoString 

func (s ListLaunchPathsOutput) GoString() string

GoString returns the string representation

func (ListLaunchPathsOutput) String 

func (s ListLaunchPathsOutput) String() string

String returns the string representation

type ListRecordHistoryInput 

type ListRecordHistoryInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The access level for obtaining results. If left unspecified, User level access
	// is used.
	AccessLevelFilter *AccessLevelFilter `type:"structure"`

	// The maximum number of items to return in the results. If more results exist
	// than fit in the specified PageSize, the value of NextPageToken in the response
	// is non-null.
	PageSize *int64 `type:"integer"`

	// The page token of the first page retrieved. If null, this retrieves the first
	// page of size PageSize.
	PageToken *string `type:"string"`

	// The filter to limit search results.
	SearchFilter *ListRecordHistorySearchFilter `type:"structure"`
	// contains filtered or unexported fields
}

func (ListRecordHistoryInput) GoString 

func (s ListRecordHistoryInput) GoString() string

GoString returns the string representation

func (ListRecordHistoryInput) String 

func (s ListRecordHistoryInput) String() string

String returns the string representation

type ListRecordHistoryOutput 

type ListRecordHistoryOutput struct {

	// The page token to use to retrieve the next page of results for this operation.
	// If there are no more pages, this value is null.
	NextPageToken *string `type:"string"`

	// A list of record detail objects, listed in reverse chronological order.
	RecordDetails []*RecordDetail `type:"list"`
	// contains filtered or unexported fields
}

func (ListRecordHistoryOutput) GoString 

func (s ListRecordHistoryOutput) GoString() string

GoString returns the string representation

func (ListRecordHistoryOutput) String 

func (s ListRecordHistoryOutput) String() string

String returns the string representation

type ListRecordHistorySearchFilter 

type ListRecordHistorySearchFilter struct {

	// The filter key.
	Key *string `type:"string"`

	// The filter value for Key.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The search filter to limit results when listing request history records.

func (ListRecordHistorySearchFilter) GoString 

func (s ListRecordHistorySearchFilter) GoString() string

GoString returns the string representation

func (ListRecordHistorySearchFilter) String 

func (s ListRecordHistorySearchFilter) String() string

String returns the string representation

type ParameterConstraints 

type ParameterConstraints struct {

	// The values that the administrator has allowed for the parameter.
	AllowedValues []*string `type:"list"`
	// contains filtered or unexported fields
}

The constraints that the administrator has put on the parameter.

func (ParameterConstraints) GoString 

func (s ParameterConstraints) GoString() string

GoString returns the string representation

func (ParameterConstraints) String 

func (s ParameterConstraints) String() string

String returns the string representation

type ProductViewAggregationValue 

type ProductViewAggregationValue struct {

	// An approximate count of the products that match the value.
	ApproximateCount *int64 `type:"integer"`

	// The value of the product view aggregation.
	Value *string `type:"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.

func (ProductViewAggregationValue) GoString 

func (s ProductViewAggregationValue) GoString() string

GoString returns the string representation

func (ProductViewAggregationValue) String 

func (s ProductViewAggregationValue) String() string

String returns the string representation

type ProductViewSummary 

type ProductViewSummary struct {

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

	// A value of false indicates that the product does not have a default path,
	// while a value of true indicates that it does. If it's false, call ListLaunchPaths
	// to disambiguate between paths. If true, ListLaunchPaths is not required,
	// and the output of the ProductViewSummary operation can be used directly with
	// DescribeProvisioningParameters.
	HasDefaultPath *bool `type:"boolean"`

	// The product view identifier.
	Id *string `min:"1" type:"string"`

	// The name of the product.
	Name *string `type:"string"`

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

	// The product identifier.
	ProductId *string `min:"1" type:"string"`

	// Short description of the product.
	ShortDescription *string `type:"string"`

	// The description of the support for this Product.
	SupportDescription *string `type:"string"`

	// The email contact information to obtain support for this Product.
	SupportEmail *string `type:"string"`

	// The URL information to obtain support for this Product.
	SupportUrl *string `type:"string"`

	// The product type. Contact the product administrator for the significance
	// of this value.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The summary metadata about the specified product.

func (ProductViewSummary) GoString 

func (s ProductViewSummary) GoString() string

GoString returns the string representation

func (ProductViewSummary) String 

func (s ProductViewSummary) String() string

String returns the string representation

type ProvisionProductInput 

type ProvisionProductInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
	// events.
	NotificationArns []*string `type:"list"`

	// The identifier of the path for this product's provisioning. This value is
	// optional if the product has a default path, and is required if there is more
	// than one path for the specified product.
	PathId *string `min:"1" type:"string"`

	// The identifier of the product.
	//
	// ProductId is a required field
	ProductId *string `min:"1" type:"string" required:"true"`

	// An idempotency token that uniquely identifies the provisioning request.
	//
	// ProvisionToken is a required field
	ProvisionToken *string `min:"1" type:"string" required:"true" idempotencyToken:"true"`

	// A user-friendly name to identify the ProvisionedProduct object. This value
	// must be unique for the AWS account and cannot be updated after the product
	// is provisioned.
	//
	// ProvisionedProductName is a required field
	ProvisionedProductName *string `type:"string" required:"true"`

	// The provisioning artifact identifier for this product.
	//
	// ProvisioningArtifactId is a required field
	ProvisioningArtifactId *string `min:"1" type:"string" required:"true"`

	// Parameters specified by the administrator that are required for provisioning
	// the product.
	ProvisioningParameters []*ProvisioningParameter `type:"list"`

	// A list of tags to use as provisioning options.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ProvisionProductInput) GoString 

func (s ProvisionProductInput) GoString() string

GoString returns the string representation

func (ProvisionProductInput) String 

func (s ProvisionProductInput) String() string

String returns the string representation

func (*ProvisionProductInput) Validate 

func (s *ProvisionProductInput) Validate() error

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

type ProvisionProductOutput 

type ProvisionProductOutput struct {

	// The detailed result of the ProvisionProduct request, containing the inputs
	// made to that request, the current state of the request, a pointer to the
	// ProvisionedProduct object of the request, and a list of any errors that the
	// request encountered.
	RecordDetail *RecordDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (ProvisionProductOutput) GoString 

func (s ProvisionProductOutput) GoString() string

GoString returns the string representation

func (ProvisionProductOutput) String 

func (s ProvisionProductOutput) String() string

String returns the string representation

type ProvisionedProductDetail 

type ProvisionedProductDetail struct {

	// The ARN associated with the ProvisionedProduct object.
	Arn *string `min:"1" type:"string"`

	// The time the ProvisionedProduct was created.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The identifier of the ProvisionedProduct object.
	Id *string `type:"string"`

	// An idempotency token that uniquely identifies this ProvisionedProduct.
	IdempotencyToken *string `min:"1" type:"string"`

	// The record identifier of the last request performed on this ProvisionedProduct
	// object.
	LastRecordId *string `type:"string"`

	// The user-friendly name of the ProvisionedProduct object.
	Name *string `min:"1" type:"string"`

	// The current status of the ProvisionedProduct.
	Status *string `type:"string" enum:"RecordStatus"`

	// The current status message of the ProvisionedProduct.
	StatusMessage *string `type:"string"`

	// The type of the ProvisionedProduct object.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a ProvisionedProduct object.

func (ProvisionedProductDetail) GoString 

func (s ProvisionedProductDetail) GoString() string

GoString returns the string representation

func (ProvisionedProductDetail) String 

func (s ProvisionedProductDetail) String() string

String returns the string representation

type ProvisioningArtifact 

type ProvisioningArtifact struct {

	// The time that the artifact was created by the Administrator.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The text description of the artifact.
	Description *string `type:"string"`

	// The identifier for the artifact.
	Id *string `min:"1" type:"string"`

	// The name of the artifact.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information indicating the ways in which a product can be provisioned.

func (ProvisioningArtifact) GoString 

func (s ProvisioningArtifact) GoString() string

GoString returns the string representation

func (ProvisioningArtifact) String 

func (s ProvisioningArtifact) String() string

String returns the string representation

type ProvisioningArtifactParameter 

type ProvisioningArtifactParameter struct {

	// The default value for this parameter.
	DefaultValue *string `type:"string"`

	// The text description of the parameter.
	Description *string `type:"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 `type:"boolean"`

	// The list of constraints that the administrator has put on the parameter.
	ParameterConstraints *ParameterConstraints `type:"structure"`

	// The parameter key.
	ParameterKey *string `type:"string"`

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

A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.

func (ProvisioningArtifactParameter) GoString 

func (s ProvisioningArtifactParameter) GoString() string

GoString returns the string representation

func (ProvisioningArtifactParameter) String 

func (s ProvisioningArtifactParameter) String() string

String returns the string representation

type ProvisioningParameter 

type ProvisioningParameter struct {

	// The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.
	Key *string `type:"string"`

	// The value to use for provisioning. Any constraints on this value can be found
	// in ProvisioningArtifactParameter for Key.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The arameter key/value pairs used to provision a product.

func (ProvisioningParameter) GoString 

func (s ProvisioningParameter) GoString() string

GoString returns the string representation

func (ProvisioningParameter) String 

func (s ProvisioningParameter) String() string

String returns the string representation

type RecordDetail 

type RecordDetail struct {

	// The time when the record for the ProvisionedProduct object was created.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The identifier of the path for this product's provisioning.
	PathId *string `min:"1" type:"string"`

	// The identifier of the product.
	ProductId *string `min:"1" type:"string"`

	// The identifier of the ProvisionedProduct object.
	ProvisionedProductId *string `min:"1" type:"string"`

	// The user-friendly name of the ProvisionedProduct object.
	ProvisionedProductName *string `type:"string"`

	// The type of the ProvisionedProduct object.
	ProvisionedProductType *string `type:"string"`

	// The provisioning artifact identifier for this product.
	ProvisioningArtifactId *string `min:"1" type:"string"`

	// A list of errors that occurred while processing the request.
	RecordErrors []*RecordError `type:"list"`

	// The identifier of the ProvisionedProduct object record.
	RecordId *string `min:"1" type:"string"`

	// List of tags associated with this record.
	RecordTags []*RecordTag `type:"list"`

	// The record type for this record.
	RecordType *string `type:"string"`

	// The status of the ProvisionedProduct object.
	Status *string `type:"string" enum:"RecordStatus"`

	// The time when the record for the ProvisionedProduct object was last updated.
	UpdatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The full details of a specific ProvisionedProduct object.

func (RecordDetail) GoString 

func (s RecordDetail) GoString() string

GoString returns the string representation

func (RecordDetail) String 

func (s RecordDetail) String() string

String returns the string representation

type RecordError 

type RecordError struct {

	// The numeric value of the error.
	Code *string `type:"string"`

	// The text description of the error.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

The error code and description resulting from an operation.

func (RecordError) GoString 

func (s RecordError) GoString() string

GoString returns the string representation

func (RecordError) String 

func (s RecordError) String() string

String returns the string representation

type RecordOutput 

type RecordOutput struct {

	// The text description of the output.
	Description *string `type:"string"`

	// The output key.
	OutputKey *string `type:"string"`

	// The output value.
	OutputValue *string `type:"string"`
	// contains filtered or unexported fields
}

An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.

func (RecordOutput) GoString 

func (s RecordOutput) GoString() string

GoString returns the string representation

func (RecordOutput) String 

func (s RecordOutput) String() string

String returns the string representation

type RecordTag 

type RecordTag struct {

	// The key for this tag.
	Key *string `min:"1" type:"string"`

	// The value for this tag.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A tag associated with the record, stored as a key-value pair.

func (RecordTag) GoString 

func (s RecordTag) GoString() string

GoString returns the string representation

func (RecordTag) String 

func (s RecordTag) String() string

String returns the string representation

type ScanProvisionedProductsInput 

type ScanProvisionedProductsInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The access level for obtaining results. If left unspecified, User level access
	// is used.
	AccessLevelFilter *AccessLevelFilter `type:"structure"`

	// The maximum number of items to return in the results. If more results exist
	// than fit in the specified PageSize, the value of NextPageToken in the response
	// is non-null.
	PageSize *int64 `type:"integer"`

	// The page token of the first page retrieved. If null, this retrieves the first
	// page of size PageSize.
	PageToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ScanProvisionedProductsInput) GoString 

func (s ScanProvisionedProductsInput) GoString() string

GoString returns the string representation

func (ScanProvisionedProductsInput) String 

func (s ScanProvisionedProductsInput) String() string

String returns the string representation

type ScanProvisionedProductsOutput 

type ScanProvisionedProductsOutput struct {

	// The page token to use to retrieve the next page of results for this operation.
	// If there are no more pages, this value is null.
	NextPageToken *string `type:"string"`

	// A list of ProvisionedProduct detail objects.
	ProvisionedProducts []*ProvisionedProductDetail `type:"list"`
	// contains filtered or unexported fields
}

func (ScanProvisionedProductsOutput) GoString 

func (s ScanProvisionedProductsOutput) GoString() string

GoString returns the string representation

func (ScanProvisionedProductsOutput) String 

func (s ScanProvisionedProductsOutput) String() string

String returns the string representation

type SearchProductsInput 

type SearchProductsInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The list of filters with which to limit search results. If no search filters
	// are specified, the output is all the products to which the calling user has
	// access.
	Filters map[string][]*string `type:"map"`

	// The maximum number of items to return in the results. If more results exist
	// than fit in the specified PageSize, the value of NextPageToken in the response
	// is non-null.
	PageSize *int64 `type:"integer"`

	// The page token of the first page retrieved. If null, this retrieves the first
	// page of size PageSize.
	PageToken *string `type:"string"`

	// The sort field specifier. If no value is specified, results are not sorted.
	SortBy *string `type:"string" enum:"ProductViewSortBy"`

	// The sort order specifier. If no value is specified, results are not sorted.
	SortOrder *string `type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

func (SearchProductsInput) GoString 

func (s SearchProductsInput) GoString() string

GoString returns the string representation

func (SearchProductsInput) String 

func (s SearchProductsInput) String() string

String returns the string representation

type SearchProductsOutput 

type SearchProductsOutput struct {

	// The page token to use to retrieve the next page of results for this operation.
	// If there are no more pages, this value is null.
	NextPageToken *string `type:"string"`

	// A list of the product view aggregation value objects.
	ProductViewAggregations map[string][]*ProductViewAggregationValue `type:"map"`

	// A list of the product view summary objects.
	ProductViewSummaries []*ProductViewSummary `type:"list"`
	// contains filtered or unexported fields
}

func (SearchProductsOutput) GoString 

func (s SearchProductsOutput) GoString() string

GoString returns the string representation

func (SearchProductsOutput) String 

func (s SearchProductsOutput) String() string

String returns the string representation

type ServiceCatalog 

type ServiceCatalog struct {
	*client.Client
}

Overview 

AWS Service Catalog (https://aws.amazon.com/servicecatalog/) allows organizations

to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts (http://docs.aws.amazon.com/servicecatalog/latest/userguide/what-is_concepts.html). 

Additional Resources

  AWS Service Catalog Administrator Guide (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)

  AWS Service Catalog User Guide (http://docs.aws.amazon.com/servicecatalog/latest/userguide/introduction.html)

The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ServiceCatalog

New creates a new instance of the ServiceCatalog client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a ServiceCatalog client from just a session.
svc := servicecatalog.New(mySession)

// Create a ServiceCatalog client with additional configuration
svc := servicecatalog.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ServiceCatalog) DescribeProduct 

func (c *ServiceCatalog) DescribeProduct(input *DescribeProductInput) (*DescribeProductOutput, error)

DescribeProduct API operation for AWS Service Catalog.

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation DescribeProduct for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidParametersException One or more parameters provided to the operation are invalid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.DescribeProductInput{
		Id:             aws.String("Id"), // Required
		AcceptLanguage: aws.String("AcceptLanguage"),
	}
	resp, err := svc.DescribeProduct(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) DescribeProductRequest 

func (c *ServiceCatalog) DescribeProductRequest(input *DescribeProductInput) (req *request.Request, output *DescribeProductOutput)

DescribeProductRequest generates a "aws/request.Request" representing the client's request for the DescribeProduct operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeProduct for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeProduct method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeProductRequest method.
req, resp := client.DescribeProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) DescribeProductView 

func (c *ServiceCatalog) DescribeProductView(input *DescribeProductViewInput) (*DescribeProductViewOutput, error)

DescribeProductView API operation for AWS Service Catalog.

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation DescribeProductView for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidParametersException One or more parameters provided to the operation are invalid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.DescribeProductViewInput{
		Id:             aws.String("Id"), // Required
		AcceptLanguage: aws.String("AcceptLanguage"),
	}
	resp, err := svc.DescribeProductView(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) DescribeProductViewRequest 

func (c *ServiceCatalog) DescribeProductViewRequest(input *DescribeProductViewInput) (req *request.Request, output *DescribeProductViewOutput)

DescribeProductViewRequest generates a "aws/request.Request" representing the client's request for the DescribeProductView operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeProductView for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeProductView method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeProductViewRequest method.
req, resp := client.DescribeProductViewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) DescribeProvisioningParameters 

func (c *ServiceCatalog) DescribeProvisioningParameters(input *DescribeProvisioningParametersInput) (*DescribeProvisioningParametersOutput, error)

DescribeProvisioningParameters API operation for AWS Service Catalog.

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation DescribeProvisioningParameters for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.

  • ResourceNotFoundException The specified resource was not found.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.DescribeProvisioningParametersInput{
		ProductId:              aws.String("Id"), // Required
		ProvisioningArtifactId: aws.String("Id"), // Required
		AcceptLanguage:         aws.String("AcceptLanguage"),
		PathId:                 aws.String("Id"),
	}
	resp, err := svc.DescribeProvisioningParameters(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) DescribeProvisioningParametersRequest 

func (c *ServiceCatalog) DescribeProvisioningParametersRequest(input *DescribeProvisioningParametersInput) (req *request.Request, output *DescribeProvisioningParametersOutput)

DescribeProvisioningParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeProvisioningParameters operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeProvisioningParameters for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeProvisioningParameters method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeProvisioningParametersRequest method.
req, resp := client.DescribeProvisioningParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) DescribeRecord 

func (c *ServiceCatalog) DescribeRecord(input *DescribeRecordInput) (*DescribeRecordOutput, error)

DescribeRecord API operation for AWS Service Catalog.

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation DescribeRecord for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException The specified resource was not found.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.DescribeRecordInput{
		Id:             aws.String("Id"), // Required
		AcceptLanguage: aws.String("AcceptLanguage"),
		PageSize:       aws.Int64(1),
		PageToken:      aws.String("PageToken"),
	}
	resp, err := svc.DescribeRecord(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) DescribeRecordRequest 

func (c *ServiceCatalog) DescribeRecordRequest(input *DescribeRecordInput) (req *request.Request, output *DescribeRecordOutput)

DescribeRecordRequest generates a "aws/request.Request" representing the client's request for the DescribeRecord operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeRecord for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeRecord method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeRecordRequest method.
req, resp := client.DescribeRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) ListLaunchPaths 

func (c *ServiceCatalog) ListLaunchPaths(input *ListLaunchPathsInput) (*ListLaunchPathsOutput, error)

ListLaunchPaths API operation for AWS Service Catalog.

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation ListLaunchPaths for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.

  • ResourceNotFoundException The specified resource was not found.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.ListLaunchPathsInput{
		ProductId:      aws.String("Id"), // Required
		AcceptLanguage: aws.String("AcceptLanguage"),
		PageSize:       aws.Int64(1),
		PageToken:      aws.String("PageToken"),
	}
	resp, err := svc.ListLaunchPaths(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) ListLaunchPathsRequest 

func (c *ServiceCatalog) ListLaunchPathsRequest(input *ListLaunchPathsInput) (req *request.Request, output *ListLaunchPathsOutput)

ListLaunchPathsRequest generates a "aws/request.Request" representing the client's request for the ListLaunchPaths operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListLaunchPaths for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListLaunchPaths method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListLaunchPathsRequest method.
req, resp := client.ListLaunchPathsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) ListRecordHistory 

func (c *ServiceCatalog) ListRecordHistory(input *ListRecordHistoryInput) (*ListRecordHistoryOutput, error)

ListRecordHistory API operation for AWS Service Catalog.

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation ListRecordHistory for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.ListRecordHistoryInput{
		AcceptLanguage: aws.String("AcceptLanguage"),
		AccessLevelFilter: &servicecatalog.AccessLevelFilter{
			Key:   aws.String("AccessLevelFilterKey"),
			Value: aws.String("AccessLevelFilterValue"),
		},
		PageSize:  aws.Int64(1),
		PageToken: aws.String("PageToken"),
		SearchFilter: &servicecatalog.ListRecordHistorySearchFilter{
			Key:   aws.String("SearchFilterKey"),
			Value: aws.String("SearchFilterValue"),
		},
	}
	resp, err := svc.ListRecordHistory(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) ListRecordHistoryRequest 

func (c *ServiceCatalog) ListRecordHistoryRequest(input *ListRecordHistoryInput) (req *request.Request, output *ListRecordHistoryOutput)

ListRecordHistoryRequest generates a "aws/request.Request" representing the client's request for the ListRecordHistory operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListRecordHistory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListRecordHistory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListRecordHistoryRequest method.
req, resp := client.ListRecordHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) ProvisionProduct 

func (c *ServiceCatalog) ProvisionProduct(input *ProvisionProductInput) (*ProvisionProductOutput, error)

ProvisionProduct API operation for AWS Service Catalog.

Requests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation ProvisionProduct for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.

  • ResourceNotFoundException The specified resource was not found.

  • DuplicateResourceException The specified resource is a duplicate.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.ProvisionProductInput{
		ProductId:              aws.String("Id"),                     // Required
		ProvisionToken:         aws.String("IdempotencyToken"),       // Required
		ProvisionedProductName: aws.String("ProvisionedProductName"), // Required
		ProvisioningArtifactId: aws.String("Id"),                     // Required
		AcceptLanguage:         aws.String("AcceptLanguage"),
		NotificationArns: []*string{
			aws.String("NotificationArn"), // Required
			// More values...
		},
		PathId: aws.String("Id"),
		ProvisioningParameters: []*servicecatalog.ProvisioningParameter{
			{ // Required
				Key:   aws.String("ParameterKey"),
				Value: aws.String("ParameterValue"),
			},
			// More values...
		},
		Tags: []*servicecatalog.Tag{
			{ // Required
				Key:   aws.String("TagKey"),
				Value: aws.String("TagValue"),
			},
			// More values...
		},
	}
	resp, err := svc.ProvisionProduct(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) ProvisionProductRequest 

func (c *ServiceCatalog) ProvisionProductRequest(input *ProvisionProductInput) (req *request.Request, output *ProvisionProductOutput)

ProvisionProductRequest generates a "aws/request.Request" representing the client's request for the ProvisionProduct operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ProvisionProduct for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ProvisionProduct method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ProvisionProductRequest method.
req, resp := client.ProvisionProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) ScanProvisionedProducts 

func (c *ServiceCatalog) ScanProvisionedProducts(input *ScanProvisionedProductsInput) (*ScanProvisionedProductsOutput, error)

ScanProvisionedProducts API operation for AWS Service Catalog.

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation ScanProvisionedProducts for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.ScanProvisionedProductsInput{
		AcceptLanguage: aws.String("AcceptLanguage"),
		AccessLevelFilter: &servicecatalog.AccessLevelFilter{
			Key:   aws.String("AccessLevelFilterKey"),
			Value: aws.String("AccessLevelFilterValue"),
		},
		PageSize:  aws.Int64(1),
		PageToken: aws.String("PageToken"),
	}
	resp, err := svc.ScanProvisionedProducts(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) ScanProvisionedProductsRequest 

func (c *ServiceCatalog) ScanProvisionedProductsRequest(input *ScanProvisionedProductsInput) (req *request.Request, output *ScanProvisionedProductsOutput)

ScanProvisionedProductsRequest generates a "aws/request.Request" representing the client's request for the ScanProvisionedProducts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ScanProvisionedProducts for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ScanProvisionedProducts method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ScanProvisionedProductsRequest method.
req, resp := client.ScanProvisionedProductsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) SearchProducts 

func (c *ServiceCatalog) SearchProducts(input *SearchProductsInput) (*SearchProductsOutput, error)

SearchProducts API operation for AWS Service Catalog.

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation SearchProducts for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.SearchProductsInput{
		AcceptLanguage: aws.String("AcceptLanguage"),
		Filters: map[string][]*string{
			"Key": { // Required
				aws.String("ProductViewFilterValue"), // Required
				// More values...
			},
			// More values...
		},
		PageSize:  aws.Int64(1),
		PageToken: aws.String("PageToken"),
		SortBy:    aws.String("ProductViewSortBy"),
		SortOrder: aws.String("SortOrder"),
	}
	resp, err := svc.SearchProducts(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) SearchProductsRequest 

func (c *ServiceCatalog) SearchProductsRequest(input *SearchProductsInput) (req *request.Request, output *SearchProductsOutput)

SearchProductsRequest generates a "aws/request.Request" representing the client's request for the SearchProducts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SearchProducts for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SearchProducts method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SearchProductsRequest method.
req, resp := client.SearchProductsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) TerminateProvisionedProduct 

func (c *ServiceCatalog) TerminateProvisionedProduct(input *TerminateProvisionedProductInput) (*TerminateProvisionedProductOutput, error)

TerminateProvisionedProduct API operation for AWS Service Catalog.

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation TerminateProvisionedProduct for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException The specified resource was not found.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.TerminateProvisionedProductInput{
		TerminateToken:         aws.String("IdempotencyToken"), // Required
		AcceptLanguage:         aws.String("AcceptLanguage"),
		IgnoreErrors:           aws.Bool(true),
		ProvisionedProductId:   aws.String("Id"),
		ProvisionedProductName: aws.String("ProvisionedProductNameOrArn"),
	}
	resp, err := svc.TerminateProvisionedProduct(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) TerminateProvisionedProductRequest 

func (c *ServiceCatalog) TerminateProvisionedProductRequest(input *TerminateProvisionedProductInput) (req *request.Request, output *TerminateProvisionedProductOutput)

TerminateProvisionedProductRequest generates a "aws/request.Request" representing the client's request for the TerminateProvisionedProduct operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See TerminateProvisionedProduct for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TerminateProvisionedProduct method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the TerminateProvisionedProductRequest method.
req, resp := client.TerminateProvisionedProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ServiceCatalog) UpdateProvisionedProduct 

func (c *ServiceCatalog) UpdateProvisionedProduct(input *UpdateProvisionedProductInput) (*UpdateProvisionedProductOutput, error)

UpdateProvisionedProduct API operation for AWS Service Catalog.

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Service Catalog's API operation UpdateProvisionedProduct for usage and error information.

Returned Error Codes:

  • InvalidParametersException One or more parameters provided to the operation are invalid.

  • ResourceNotFoundException The specified resource was not found.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicecatalog"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := servicecatalog.New(sess)

	params := &servicecatalog.UpdateProvisionedProductInput{
		UpdateToken:            aws.String("IdempotencyToken"), // Required
		AcceptLanguage:         aws.String("AcceptLanguage"),
		PathId:                 aws.String("Id"),
		ProductId:              aws.String("Id"),
		ProvisionedProductId:   aws.String("Id"),
		ProvisionedProductName: aws.String("ProvisionedProductNameOrArn"),
		ProvisioningArtifactId: aws.String("Id"),
		ProvisioningParameters: []*servicecatalog.UpdateProvisioningParameter{
			{ // Required
				Key:              aws.String("ParameterKey"),
				UsePreviousValue: aws.Bool(true),
				Value:            aws.String("ParameterValue"),
			},
			// More values...
		},
	}
	resp, err := svc.UpdateProvisionedProduct(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ServiceCatalog) UpdateProvisionedProductRequest 

func (c *ServiceCatalog) UpdateProvisionedProductRequest(input *UpdateProvisionedProductInput) (req *request.Request, output *UpdateProvisionedProductOutput)

UpdateProvisionedProductRequest generates a "aws/request.Request" representing the client's request for the UpdateProvisionedProduct operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateProvisionedProduct for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateProvisionedProduct method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the UpdateProvisionedProductRequest method.
req, resp := client.UpdateProvisionedProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

type Tag 

type Tag struct {

	// The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
	Key *string `min:"1" type:"string"`

	// The esired value for this key.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TerminateProvisionedProductInput 

type TerminateProvisionedProductInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct
	// object even if it cannot delete the underlying resources.
	IgnoreErrors *bool `type:"boolean"`

	// The identifier of the ProvisionedProduct object to terminate. You must specify
	// either ProvisionedProductName or ProvisionedProductId, but not both.
	ProvisionedProductId *string `min:"1" type:"string"`

	// The name of the ProvisionedProduct object to terminate. You must specify
	// either ProvisionedProductName or ProvisionedProductId, but not both.
	ProvisionedProductName *string `min:"1" type:"string"`

	// An idempotency token that uniquely identifies the termination request. This
	// token is only valid during the termination process. After the ProvisionedProduct
	// object is terminated, further requests to terminate the same ProvisionedProduct
	// object always return ResourceNotFound regardless of the value of TerminateToken.
	//
	// TerminateToken is a required field
	TerminateToken *string `min:"1" type:"string" required:"true" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (TerminateProvisionedProductInput) GoString 

func (s TerminateProvisionedProductInput) GoString() string

GoString returns the string representation

func (TerminateProvisionedProductInput) String 

func (s TerminateProvisionedProductInput) String() string

String returns the string representation

func (*TerminateProvisionedProductInput) Validate 

func (s *TerminateProvisionedProductInput) Validate() error

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

type TerminateProvisionedProductOutput 

type TerminateProvisionedProductOutput struct {

	// The detailed result of the TerminateProvisionedProduct request, containing
	// the inputs made to that request, the current state of the request, a pointer
	// to the ProvisionedProduct object that the request is modifying, and a list
	// of any errors that the request encountered.
	RecordDetail *RecordDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (TerminateProvisionedProductOutput) GoString 

func (s TerminateProvisionedProductOutput) GoString() string

GoString returns the string representation

func (TerminateProvisionedProductOutput) String 

func (s TerminateProvisionedProductOutput) String() string

String returns the string representation

type UpdateProvisionedProductInput 

type UpdateProvisionedProductInput struct {

	// The language code to use for this operation. Supported language codes are
	// as follows:
	//
	// "en" (English)
	//
	// "jp" (Japanese)
	//
	// "zh" (Chinese)
	//
	// If no code is specified, "en" is used as the default.
	AcceptLanguage *string `type:"string"`

	// The identifier of the path to use in the updated ProvisionedProduct object.
	// This value is optional if the product has a default path, and is required
	// if there is more than one path for the specified product.
	PathId *string `min:"1" type:"string"`

	// The identifier of the ProvisionedProduct object.
	ProductId *string `min:"1" type:"string"`

	// The identifier of the ProvisionedProduct object to update. You must specify
	// either ProvisionedProductName or ProvisionedProductId, but not both.
	ProvisionedProductId *string `min:"1" type:"string"`

	// The updated name of the ProvisionedProduct object . You must specify either
	// ProvisionedProductName or ProvisionedProductId, but not both.
	ProvisionedProductName *string `min:"1" type:"string"`

	// The provisioning artifact identifier for this product.
	ProvisioningArtifactId *string `min:"1" type:"string"`

	// A list of ProvisioningParameter objects used to update the ProvisionedProduct
	// object.
	ProvisioningParameters []*UpdateProvisioningParameter `type:"list"`

	// The idempotency token that uniquely identifies the provisioning update request.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateProvisionedProductInput) GoString 

func (s UpdateProvisionedProductInput) GoString() string

GoString returns the string representation

func (UpdateProvisionedProductInput) String 

func (s UpdateProvisionedProductInput) String() string

String returns the string representation

func (*UpdateProvisionedProductInput) Validate 

func (s *UpdateProvisionedProductInput) Validate() error

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

type UpdateProvisionedProductOutput 

type UpdateProvisionedProductOutput struct {

	// The detailed result of the UpdateProvisionedProduct request, containing the
	// inputs made to that request, the current state of the request, a pointer
	// to the ProvisionedProduct object that the request is modifying, and a list
	// of any errors that the request encountered.
	RecordDetail *RecordDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateProvisionedProductOutput) GoString 

func (s UpdateProvisionedProductOutput) GoString() string

GoString returns the string representation

func (UpdateProvisionedProductOutput) String 

func (s UpdateProvisionedProductOutput) String() string

String returns the string representation

type UpdateProvisioningParameter 

type UpdateProvisioningParameter struct {

	// The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.
	Key *string `type:"string"`

	// If true, uses the currently set value for Key, ignoring UpdateProvisioningParameter.Value.
	UsePreviousValue *bool `type:"boolean"`

	// The value to use for updating the product provisioning. Any constraints on
	// this value can be found in the ProvisioningArtifactParameter parameter for
	// Key.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The parameter key/value pair used to update a ProvisionedProduct object. If UsePreviousValue is set to true, Value is ignored and the value for Key is kept as previously set (current value).

func (UpdateProvisioningParameter) GoString 

func (s UpdateProvisioningParameter) GoString() string

GoString returns the string representation

func (UpdateProvisioningParameter) String 

func (s UpdateProvisioningParameter) String() string

String returns the string representation

type UsageInstruction 

type UsageInstruction struct {

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

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

Additional information provided by the administrator.

func (UsageInstruction) GoString 

func (s UsageInstruction) GoString() string

GoString returns the string representation

func (UsageInstruction) String 

func (s UsageInstruction) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package servicecatalogiface provides an interface to enable mocking the AWS Service Catalog service client for testing your code.
 Package servicecatalogiface provides an interface to enable mocking the AWS Service Catalog service client for testing your code.

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.