Documentation ¶
Overview ¶
Package marketplacedeployment provides the client and types for making API requests to AWS Marketplace Deployment Service.
The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.
See https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25 for more information on this service.
See marketplacedeployment package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacedeployment/
Using the Client ¶
To contact AWS Marketplace Deployment Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Marketplace Deployment Service client MarketplaceDeployment for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacedeployment/#New
Index ¶
- Constants
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type DeploymentParameterInput_
- func (s DeploymentParameterInput_) GoString() string
- func (s *DeploymentParameterInput_) SetName(v string) *DeploymentParameterInput_
- func (s *DeploymentParameterInput_) SetSecretString(v string) *DeploymentParameterInput_
- func (s DeploymentParameterInput_) String() string
- func (s *DeploymentParameterInput_) Validate() error
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type MarketplaceDeployment
- func (c *MarketplaceDeployment) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *MarketplaceDeployment) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *MarketplaceDeployment) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *MarketplaceDeployment) PutDeploymentParameter(input *PutDeploymentParameterInput) (*PutDeploymentParameterOutput, error)
- func (c *MarketplaceDeployment) PutDeploymentParameterRequest(input *PutDeploymentParameterInput) (req *request.Request, output *PutDeploymentParameterOutput)
- func (c *MarketplaceDeployment) PutDeploymentParameterWithContext(ctx aws.Context, input *PutDeploymentParameterInput, opts ...request.Option) (*PutDeploymentParameterOutput, error)
- func (c *MarketplaceDeployment) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *MarketplaceDeployment) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *MarketplaceDeployment) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *MarketplaceDeployment) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *MarketplaceDeployment) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *MarketplaceDeployment) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- type PutDeploymentParameterInput
- func (s PutDeploymentParameterInput) GoString() string
- func (s *PutDeploymentParameterInput) SetAgreementId(v string) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetCatalog(v string) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetClientToken(v string) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetDeploymentParameter(v *DeploymentParameterInput_) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetExpirationDate(v time.Time) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetProductId(v string) *PutDeploymentParameterInput
- func (s *PutDeploymentParameterInput) SetTags(v map[string]*string) *PutDeploymentParameterInput
- func (s PutDeploymentParameterInput) String() string
- func (s *PutDeploymentParameterInput) Validate() error
- type PutDeploymentParameterOutput
- func (s PutDeploymentParameterOutput) GoString() string
- func (s *PutDeploymentParameterOutput) SetAgreementId(v string) *PutDeploymentParameterOutput
- func (s *PutDeploymentParameterOutput) SetDeploymentParameterId(v string) *PutDeploymentParameterOutput
- func (s *PutDeploymentParameterOutput) SetResourceArn(v string) *PutDeploymentParameterOutput
- func (s *PutDeploymentParameterOutput) SetTags(v map[string]*string) *PutDeploymentParameterOutput
- func (s PutDeploymentParameterOutput) String() string
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type TagResourceInput
- type TagResourceOutput
- type ThrottlingException
- func (s *ThrottlingException) Code() string
- func (s *ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s *ThrottlingException) Message() string
- func (s *ThrottlingException) OrigErr() error
- func (s *ThrottlingException) RequestID() string
- func (s *ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type UntagResourceInput
- type UntagResourceOutput
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
Constants ¶
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // // The request configuration has conflicts. For details, see the accompanying // error message. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // There was an internal service exception. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The specified resource wasn't found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // The maximum number of requests per account has been exceeded. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // Too many requests. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // An error occurred during validation. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "Marketplace Deployment" // Name of service. EndpointsID = "deployment-marketplace" // ID to lookup a service endpoint with. ServiceID = "Marketplace Deployment" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You do not have sufficient access to perform this action.
func (*AccessDeniedException) Code ¶
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (*AccessDeniedException) Error ¶
func (s *AccessDeniedException) Error() string
func (AccessDeniedException) GoString ¶
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AccessDeniedException) Message ¶
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (*AccessDeniedException) OrigErr ¶
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*AccessDeniedException) RequestID ¶
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*AccessDeniedException) StatusCode ¶
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (AccessDeniedException) String ¶
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException ¶
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // The unique identifier for the resource associated with the error. // // ResourceId is a required field ResourceId *string `locationName:"resourceId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request configuration has conflicts. For details, see the accompanying error message.
func (*ConflictException) Code ¶
func (s *ConflictException) Code() string
Code returns the exception type name.
func (*ConflictException) Error ¶
func (s *ConflictException) Error() string
func (ConflictException) GoString ¶
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ConflictException) Message ¶
func (s *ConflictException) Message() string
Message returns the exception's message.
func (*ConflictException) OrigErr ¶
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ConflictException) RequestID ¶
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ConflictException) StatusCode ¶
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeploymentParameterInput_ ¶
type DeploymentParameterInput_ struct { // The desired name of the deployment parameter. This is the identifier on which // deployment parameters are keyed for a given buyer and product. If this name // matches an existing deployment parameter, this request will update the existing // resource. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The text to encrypt and store in the secret. // // SecretString is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DeploymentParameterInput_'s // String and GoString methods. // // SecretString is a required field SecretString *string `locationName:"secretString" min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
The shape containing the requested deployment parameter name and secretString.
func (DeploymentParameterInput_) GoString ¶
func (s DeploymentParameterInput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeploymentParameterInput_) SetName ¶
func (s *DeploymentParameterInput_) SetName(v string) *DeploymentParameterInput_
SetName sets the Name field's value.
func (*DeploymentParameterInput_) SetSecretString ¶
func (s *DeploymentParameterInput_) SetSecretString(v string) *DeploymentParameterInput_
SetSecretString sets the SecretString field's value.
func (DeploymentParameterInput_) String ¶
func (s DeploymentParameterInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeploymentParameterInput_) Validate ¶
func (s *DeploymentParameterInput_) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InternalServerException ¶
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
There was an internal service exception.
func (*InternalServerException) Code ¶
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (*InternalServerException) Error ¶
func (s *InternalServerException) Error() string
func (InternalServerException) GoString ¶
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InternalServerException) Message ¶
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (*InternalServerException) OrigErr ¶
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalServerException) RequestID ¶
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalServerException) StatusCode ¶
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServerException) String ¶
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) associated with the deployment parameter resource // you want to list tags on. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) SetResourceArn ¶
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A map of key-value pairs, where each pair represents a tag present on the // resource. Tags map[string]*string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceOutput) SetTags ¶
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MarketplaceDeployment ¶
MarketplaceDeployment provides the API operation methods for making requests to AWS Marketplace Deployment Service. See this package's package overview docs for details on the service.
MarketplaceDeployment methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *MarketplaceDeployment
New creates a new instance of the MarketplaceDeployment 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:
mySession := session.Must(session.NewSession()) // Create a MarketplaceDeployment client from just a session. svc := marketplacedeployment.New(mySession) // Create a MarketplaceDeployment client with additional configuration svc := marketplacedeployment.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*MarketplaceDeployment) ListTagsForResource ¶
func (c *MarketplaceDeployment) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for AWS Marketplace Deployment Service.
Lists all tags that have been added to a deployment parameter resource.
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 Marketplace Deployment Service's API operation ListTagsForResource for usage and error information.
Returned Error Types:
ThrottlingException Too many requests.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException The specified resource wasn't found.
ValidationException An error occurred during validation.
InternalServerException There was an internal service exception.
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/ListTagsForResource
func (*MarketplaceDeployment) ListTagsForResourceRequest ¶
func (c *MarketplaceDeployment) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/ListTagsForResource
func (*MarketplaceDeployment) ListTagsForResourceWithContext ¶
func (c *MarketplaceDeployment) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*MarketplaceDeployment) PutDeploymentParameter ¶
func (c *MarketplaceDeployment) PutDeploymentParameter(input *PutDeploymentParameterInput) (*PutDeploymentParameterOutput, error)
PutDeploymentParameter API operation for AWS Marketplace Deployment Service.
Creates or updates a deployment parameter and is targeted by catalog and agreementId.
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 Marketplace Deployment Service's API operation PutDeploymentParameter for usage and error information.
Returned Error Types:
ThrottlingException Too many requests.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException The specified resource wasn't found.
ServiceQuotaExceededException The maximum number of requests per account has been exceeded.
ConflictException The request configuration has conflicts. For details, see the accompanying error message.
ValidationException An error occurred during validation.
InternalServerException There was an internal service exception.
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/PutDeploymentParameter
func (*MarketplaceDeployment) PutDeploymentParameterRequest ¶
func (c *MarketplaceDeployment) PutDeploymentParameterRequest(input *PutDeploymentParameterInput) (req *request.Request, output *PutDeploymentParameterOutput)
PutDeploymentParameterRequest generates a "aws/request.Request" representing the client's request for the PutDeploymentParameter operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutDeploymentParameter for more information on using the PutDeploymentParameter API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutDeploymentParameterRequest method. req, resp := client.PutDeploymentParameterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/PutDeploymentParameter
func (*MarketplaceDeployment) PutDeploymentParameterWithContext ¶
func (c *MarketplaceDeployment) PutDeploymentParameterWithContext(ctx aws.Context, input *PutDeploymentParameterInput, opts ...request.Option) (*PutDeploymentParameterOutput, error)
PutDeploymentParameterWithContext is the same as PutDeploymentParameter with the addition of the ability to pass a context and additional request options.
See PutDeploymentParameter for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*MarketplaceDeployment) TagResource ¶
func (c *MarketplaceDeployment) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS Marketplace Deployment Service.
Tags a resource.
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 Marketplace Deployment Service's API operation TagResource for usage and error information.
Returned Error Types:
ThrottlingException Too many requests.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException The specified resource wasn't found.
ConflictException The request configuration has conflicts. For details, see the accompanying error message.
ValidationException An error occurred during validation.
InternalServerException There was an internal service exception.
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/TagResource
func (*MarketplaceDeployment) TagResourceRequest ¶
func (c *MarketplaceDeployment) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/TagResource
func (*MarketplaceDeployment) TagResourceWithContext ¶
func (c *MarketplaceDeployment) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*MarketplaceDeployment) UntagResource ¶
func (c *MarketplaceDeployment) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS Marketplace Deployment Service.
Removes a tag or list of tags from a resource.
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 Marketplace Deployment Service's API operation UntagResource for usage and error information.
Returned Error Types:
ThrottlingException Too many requests.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException The specified resource wasn't found.
ConflictException The request configuration has conflicts. For details, see the accompanying error message.
ValidationException An error occurred during validation.
InternalServerException There was an internal service exception.
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/UntagResource
func (*MarketplaceDeployment) UntagResourceRequest ¶
func (c *MarketplaceDeployment) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/UntagResource
func (*MarketplaceDeployment) UntagResourceWithContext ¶
func (c *MarketplaceDeployment) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type PutDeploymentParameterInput ¶
type PutDeploymentParameterInput struct { // The unique identifier of the agreement. // // AgreementId is a required field AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"` // The catalog related to the request. Fixed value: AWS Marketplace // // Catalog is a required field Catalog *string `location:"uri" locationName:"catalog" min:"1" type:"string" required:"true"` // The idempotency token for deployment parameters. A unique identifier for // the new version. ClientToken *string `locationName:"clientToken" min:"32" type:"string" idempotencyToken:"true"` // The deployment parameter targeted to the acceptor of an agreement for which // to create the AWS Secret Manager resource. // // DeploymentParameter is a required field DeploymentParameter *DeploymentParameterInput_ `locationName:"deploymentParameter" type:"structure" required:"true"` // The date when deployment parameters expire and are scheduled for deletion. ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp" timestampFormat:"iso8601"` // The product for which AWS Marketplace will save secrets for the buyer’s // account. // // ProductId is a required field ProductId *string `location:"uri" locationName:"productId" min:"1" type:"string" required:"true"` // A map of key-value pairs, where each pair represents a tag saved to the resource. // Tags will only be applied for create operations, and they'll be ignored if // the resource already exists. Tags map[string]*string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
func (PutDeploymentParameterInput) GoString ¶
func (s PutDeploymentParameterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutDeploymentParameterInput) SetAgreementId ¶
func (s *PutDeploymentParameterInput) SetAgreementId(v string) *PutDeploymentParameterInput
SetAgreementId sets the AgreementId field's value.
func (*PutDeploymentParameterInput) SetCatalog ¶
func (s *PutDeploymentParameterInput) SetCatalog(v string) *PutDeploymentParameterInput
SetCatalog sets the Catalog field's value.
func (*PutDeploymentParameterInput) SetClientToken ¶
func (s *PutDeploymentParameterInput) SetClientToken(v string) *PutDeploymentParameterInput
SetClientToken sets the ClientToken field's value.
func (*PutDeploymentParameterInput) SetDeploymentParameter ¶
func (s *PutDeploymentParameterInput) SetDeploymentParameter(v *DeploymentParameterInput_) *PutDeploymentParameterInput
SetDeploymentParameter sets the DeploymentParameter field's value.
func (*PutDeploymentParameterInput) SetExpirationDate ¶
func (s *PutDeploymentParameterInput) SetExpirationDate(v time.Time) *PutDeploymentParameterInput
SetExpirationDate sets the ExpirationDate field's value.
func (*PutDeploymentParameterInput) SetProductId ¶
func (s *PutDeploymentParameterInput) SetProductId(v string) *PutDeploymentParameterInput
SetProductId sets the ProductId field's value.
func (*PutDeploymentParameterInput) SetTags ¶
func (s *PutDeploymentParameterInput) SetTags(v map[string]*string) *PutDeploymentParameterInput
SetTags sets the Tags field's value.
func (PutDeploymentParameterInput) String ¶
func (s PutDeploymentParameterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutDeploymentParameterInput) Validate ¶
func (s *PutDeploymentParameterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDeploymentParameterOutput ¶
type PutDeploymentParameterOutput struct { // The unique identifier of the agreement. // // AgreementId is a required field AgreementId *string `locationName:"agreementId" min:"1" type:"string" required:"true"` // The unique identifier of the deployment parameter. // // DeploymentParameterId is a required field DeploymentParameterId *string `locationName:"deploymentParameterId" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) associated with the deployment parameter resource // you want to create or update. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` // A map of key-value pairs, where each pair represents a tag saved to the resource. // Tags will only be applied for create operations, and they'll be ignored if // the resource already exists. Tags map[string]*string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
func (PutDeploymentParameterOutput) GoString ¶
func (s PutDeploymentParameterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutDeploymentParameterOutput) SetAgreementId ¶
func (s *PutDeploymentParameterOutput) SetAgreementId(v string) *PutDeploymentParameterOutput
SetAgreementId sets the AgreementId field's value.
func (*PutDeploymentParameterOutput) SetDeploymentParameterId ¶
func (s *PutDeploymentParameterOutput) SetDeploymentParameterId(v string) *PutDeploymentParameterOutput
SetDeploymentParameterId sets the DeploymentParameterId field's value.
func (*PutDeploymentParameterOutput) SetResourceArn ¶
func (s *PutDeploymentParameterOutput) SetResourceArn(v string) *PutDeploymentParameterOutput
SetResourceArn sets the ResourceArn field's value.
func (*PutDeploymentParameterOutput) SetTags ¶
func (s *PutDeploymentParameterOutput) SetTags(v map[string]*string) *PutDeploymentParameterOutput
SetTags sets the Tags field's value.
func (PutDeploymentParameterOutput) String ¶
func (s PutDeploymentParameterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified resource wasn't found.
func (*ResourceNotFoundException) Code ¶
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (*ResourceNotFoundException) Error ¶
func (s *ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResourceNotFoundException) Message ¶
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (*ResourceNotFoundException) OrigErr ¶
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceNotFoundException) RequestID ¶
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceNotFoundException) StatusCode ¶
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The maximum number of requests per account has been exceeded.
func (*ServiceQuotaExceededException) Code ¶
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (*ServiceQuotaExceededException) Error ¶
func (s *ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ServiceQuotaExceededException) Message ¶
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (*ServiceQuotaExceededException) OrigErr ¶
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ServiceQuotaExceededException) RequestID ¶
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ServiceQuotaExceededException) StatusCode ¶
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) associated with the resource you want to tag. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // A map of key-value pairs, where each pair represents a tag present on the // resource. Tags map[string]*string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
func (TagResourceInput) GoString ¶
func (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) SetResourceArn ¶
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*TagResourceInput) SetTags ¶
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) GoString ¶
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException ¶
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Too many requests.
func (*ThrottlingException) Code ¶
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (*ThrottlingException) Error ¶
func (s *ThrottlingException) Error() string
func (ThrottlingException) GoString ¶
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ThrottlingException) Message ¶
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (*ThrottlingException) OrigErr ¶
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ThrottlingException) RequestID ¶
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ThrottlingException) StatusCode ¶
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ThrottlingException) String ¶
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) associated with the resource you want to remove // the tag from. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // A list of key names of tags to be removed. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) GoString ¶
func (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) SetResourceArn ¶
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*UntagResourceInput) SetTagKeys ¶
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) GoString ¶
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException ¶
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // The field name associated with the error. // // FieldName is a required field FieldName *string `locationName:"fieldName" type:"string" required:"true"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An error occurred during validation.
func (*ValidationException) Code ¶
func (s *ValidationException) Code() string
Code returns the exception type name.
func (*ValidationException) Error ¶
func (s *ValidationException) Error() string
func (ValidationException) GoString ¶
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ValidationException) Message ¶
func (s *ValidationException) Message() string
Message returns the exception's message.
func (*ValidationException) OrigErr ¶
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ValidationException) RequestID ¶
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ValidationException) StatusCode ¶
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ValidationException) String ¶
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
Directories ¶
Path | Synopsis |
---|---|
Package marketplacedeploymentiface provides an interface to enable mocking the AWS Marketplace Deployment Service service client for testing your code.
|
Package marketplacedeploymentiface provides an interface to enable mocking the AWS Marketplace Deployment Service service client for testing your code. |