Documentation
¶
Overview ¶
Package servicecatalog provides the API client, operations, and parameter types for AWS Service Catalog.
Service Catalog ¶
Service Catalogenables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AcceptPortfolioShareInput
- type AcceptPortfolioShareOutput
- type AssociateBudgetWithResourceInput
- type AssociateBudgetWithResourceOutput
- type AssociatePrincipalWithPortfolioInput
- type AssociatePrincipalWithPortfolioOutput
- type AssociateProductWithPortfolioInput
- type AssociateProductWithPortfolioOutput
- type AssociateServiceActionWithProvisioningArtifactInput
- type AssociateServiceActionWithProvisioningArtifactOutput
- type AssociateTagOptionWithResourceInput
- type AssociateTagOptionWithResourceOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchAssociateServiceActionWithProvisioningArtifactInput
- type BatchAssociateServiceActionWithProvisioningArtifactOutput
- type BatchDisassociateServiceActionFromProvisioningArtifactInput
- type BatchDisassociateServiceActionFromProvisioningArtifactOutput
- type Client
- func (c *Client) AcceptPortfolioShare(ctx context.Context, params *AcceptPortfolioShareInput, ...) (*AcceptPortfolioShareOutput, error)
- func (c *Client) AssociateBudgetWithResource(ctx context.Context, params *AssociateBudgetWithResourceInput, ...) (*AssociateBudgetWithResourceOutput, error)
- func (c *Client) AssociatePrincipalWithPortfolio(ctx context.Context, params *AssociatePrincipalWithPortfolioInput, ...) (*AssociatePrincipalWithPortfolioOutput, error)
- func (c *Client) AssociateProductWithPortfolio(ctx context.Context, params *AssociateProductWithPortfolioInput, ...) (*AssociateProductWithPortfolioOutput, error)
- func (c *Client) AssociateServiceActionWithProvisioningArtifact(ctx context.Context, ...) (*AssociateServiceActionWithProvisioningArtifactOutput, error)
- func (c *Client) AssociateTagOptionWithResource(ctx context.Context, params *AssociateTagOptionWithResourceInput, ...) (*AssociateTagOptionWithResourceOutput, error)
- func (c *Client) BatchAssociateServiceActionWithProvisioningArtifact(ctx context.Context, ...) (*BatchAssociateServiceActionWithProvisioningArtifactOutput, error)
- func (c *Client) BatchDisassociateServiceActionFromProvisioningArtifact(ctx context.Context, ...) (*BatchDisassociateServiceActionFromProvisioningArtifactOutput, error)
- func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optFns ...func(*Options)) (*CopyProductOutput, error)
- func (c *Client) CreateConstraint(ctx context.Context, params *CreateConstraintInput, optFns ...func(*Options)) (*CreateConstraintOutput, error)
- func (c *Client) CreatePortfolio(ctx context.Context, params *CreatePortfolioInput, optFns ...func(*Options)) (*CreatePortfolioOutput, error)
- func (c *Client) CreatePortfolioShare(ctx context.Context, params *CreatePortfolioShareInput, ...) (*CreatePortfolioShareOutput, error)
- func (c *Client) CreateProduct(ctx context.Context, params *CreateProductInput, optFns ...func(*Options)) (*CreateProductOutput, error)
- func (c *Client) CreateProvisionedProductPlan(ctx context.Context, params *CreateProvisionedProductPlanInput, ...) (*CreateProvisionedProductPlanOutput, error)
- func (c *Client) CreateProvisioningArtifact(ctx context.Context, params *CreateProvisioningArtifactInput, ...) (*CreateProvisioningArtifactOutput, error)
- func (c *Client) CreateServiceAction(ctx context.Context, params *CreateServiceActionInput, ...) (*CreateServiceActionOutput, error)
- func (c *Client) CreateTagOption(ctx context.Context, params *CreateTagOptionInput, optFns ...func(*Options)) (*CreateTagOptionOutput, error)
- func (c *Client) DeleteConstraint(ctx context.Context, params *DeleteConstraintInput, optFns ...func(*Options)) (*DeleteConstraintOutput, error)
- func (c *Client) DeletePortfolio(ctx context.Context, params *DeletePortfolioInput, optFns ...func(*Options)) (*DeletePortfolioOutput, error)
- func (c *Client) DeletePortfolioShare(ctx context.Context, params *DeletePortfolioShareInput, ...) (*DeletePortfolioShareOutput, error)
- func (c *Client) DeleteProduct(ctx context.Context, params *DeleteProductInput, optFns ...func(*Options)) (*DeleteProductOutput, error)
- func (c *Client) DeleteProvisionedProductPlan(ctx context.Context, params *DeleteProvisionedProductPlanInput, ...) (*DeleteProvisionedProductPlanOutput, error)
- func (c *Client) DeleteProvisioningArtifact(ctx context.Context, params *DeleteProvisioningArtifactInput, ...) (*DeleteProvisioningArtifactOutput, error)
- func (c *Client) DeleteServiceAction(ctx context.Context, params *DeleteServiceActionInput, ...) (*DeleteServiceActionOutput, error)
- func (c *Client) DeleteTagOption(ctx context.Context, params *DeleteTagOptionInput, optFns ...func(*Options)) (*DeleteTagOptionOutput, error)
- func (c *Client) DescribeConstraint(ctx context.Context, params *DescribeConstraintInput, optFns ...func(*Options)) (*DescribeConstraintOutput, error)
- func (c *Client) DescribeCopyProductStatus(ctx context.Context, params *DescribeCopyProductStatusInput, ...) (*DescribeCopyProductStatusOutput, error)
- func (c *Client) DescribePortfolio(ctx context.Context, params *DescribePortfolioInput, optFns ...func(*Options)) (*DescribePortfolioOutput, error)
- func (c *Client) DescribePortfolioShareStatus(ctx context.Context, params *DescribePortfolioShareStatusInput, ...) (*DescribePortfolioShareStatusOutput, error)
- func (c *Client) DescribePortfolioShares(ctx context.Context, params *DescribePortfolioSharesInput, ...) (*DescribePortfolioSharesOutput, error)
- func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInput, optFns ...func(*Options)) (*DescribeProductOutput, error)
- func (c *Client) DescribeProductAsAdmin(ctx context.Context, params *DescribeProductAsAdminInput, ...) (*DescribeProductAsAdminOutput, error)
- func (c *Client) DescribeProductView(ctx context.Context, params *DescribeProductViewInput, ...) (*DescribeProductViewOutput, error)
- func (c *Client) DescribeProvisionedProduct(ctx context.Context, params *DescribeProvisionedProductInput, ...) (*DescribeProvisionedProductOutput, error)
- func (c *Client) DescribeProvisionedProductPlan(ctx context.Context, params *DescribeProvisionedProductPlanInput, ...) (*DescribeProvisionedProductPlanOutput, error)
- func (c *Client) DescribeProvisioningArtifact(ctx context.Context, params *DescribeProvisioningArtifactInput, ...) (*DescribeProvisioningArtifactOutput, error)
- func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *DescribeProvisioningParametersInput, ...) (*DescribeProvisioningParametersOutput, error)
- func (c *Client) DescribeRecord(ctx context.Context, params *DescribeRecordInput, optFns ...func(*Options)) (*DescribeRecordOutput, error)
- func (c *Client) DescribeServiceAction(ctx context.Context, params *DescribeServiceActionInput, ...) (*DescribeServiceActionOutput, error)
- func (c *Client) DescribeServiceActionExecutionParameters(ctx context.Context, params *DescribeServiceActionExecutionParametersInput, ...) (*DescribeServiceActionExecutionParametersOutput, error)
- func (c *Client) DescribeTagOption(ctx context.Context, params *DescribeTagOptionInput, optFns ...func(*Options)) (*DescribeTagOptionOutput, error)
- func (c *Client) DisableAWSOrganizationsAccess(ctx context.Context, params *DisableAWSOrganizationsAccessInput, ...) (*DisableAWSOrganizationsAccessOutput, error)
- func (c *Client) DisassociateBudgetFromResource(ctx context.Context, params *DisassociateBudgetFromResourceInput, ...) (*DisassociateBudgetFromResourceOutput, error)
- func (c *Client) DisassociatePrincipalFromPortfolio(ctx context.Context, params *DisassociatePrincipalFromPortfolioInput, ...) (*DisassociatePrincipalFromPortfolioOutput, error)
- func (c *Client) DisassociateProductFromPortfolio(ctx context.Context, params *DisassociateProductFromPortfolioInput, ...) (*DisassociateProductFromPortfolioOutput, error)
- func (c *Client) DisassociateServiceActionFromProvisioningArtifact(ctx context.Context, ...) (*DisassociateServiceActionFromProvisioningArtifactOutput, error)
- func (c *Client) DisassociateTagOptionFromResource(ctx context.Context, params *DisassociateTagOptionFromResourceInput, ...) (*DisassociateTagOptionFromResourceOutput, error)
- func (c *Client) EnableAWSOrganizationsAccess(ctx context.Context, params *EnableAWSOrganizationsAccessInput, ...) (*EnableAWSOrganizationsAccessOutput, error)
- func (c *Client) ExecuteProvisionedProductPlan(ctx context.Context, params *ExecuteProvisionedProductPlanInput, ...) (*ExecuteProvisionedProductPlanOutput, error)
- func (c *Client) ExecuteProvisionedProductServiceAction(ctx context.Context, params *ExecuteProvisionedProductServiceActionInput, ...) (*ExecuteProvisionedProductServiceActionOutput, error)
- func (c *Client) GetAWSOrganizationsAccessStatus(ctx context.Context, params *GetAWSOrganizationsAccessStatusInput, ...) (*GetAWSOrganizationsAccessStatusOutput, error)
- func (c *Client) GetProvisionedProductOutputs(ctx context.Context, params *GetProvisionedProductOutputsInput, ...) (*GetProvisionedProductOutputsOutput, error)
- func (c *Client) ImportAsProvisionedProduct(ctx context.Context, params *ImportAsProvisionedProductInput, ...) (*ImportAsProvisionedProductOutput, error)
- func (c *Client) ListAcceptedPortfolioShares(ctx context.Context, params *ListAcceptedPortfolioSharesInput, ...) (*ListAcceptedPortfolioSharesOutput, error)
- func (c *Client) ListBudgetsForResource(ctx context.Context, params *ListBudgetsForResourceInput, ...) (*ListBudgetsForResourceOutput, error)
- func (c *Client) ListConstraintsForPortfolio(ctx context.Context, params *ListConstraintsForPortfolioInput, ...) (*ListConstraintsForPortfolioOutput, error)
- func (c *Client) ListLaunchPaths(ctx context.Context, params *ListLaunchPathsInput, optFns ...func(*Options)) (*ListLaunchPathsOutput, error)
- func (c *Client) ListOrganizationPortfolioAccess(ctx context.Context, params *ListOrganizationPortfolioAccessInput, ...) (*ListOrganizationPortfolioAccessOutput, error)
- func (c *Client) ListPortfolioAccess(ctx context.Context, params *ListPortfolioAccessInput, ...) (*ListPortfolioAccessOutput, error)
- func (c *Client) ListPortfolios(ctx context.Context, params *ListPortfoliosInput, optFns ...func(*Options)) (*ListPortfoliosOutput, error)
- func (c *Client) ListPortfoliosForProduct(ctx context.Context, params *ListPortfoliosForProductInput, ...) (*ListPortfoliosForProductOutput, error)
- func (c *Client) ListPrincipalsForPortfolio(ctx context.Context, params *ListPrincipalsForPortfolioInput, ...) (*ListPrincipalsForPortfolioOutput, error)
- func (c *Client) ListProvisionedProductPlans(ctx context.Context, params *ListProvisionedProductPlansInput, ...) (*ListProvisionedProductPlansOutput, error)
- func (c *Client) ListProvisioningArtifacts(ctx context.Context, params *ListProvisioningArtifactsInput, ...) (*ListProvisioningArtifactsOutput, error)
- func (c *Client) ListProvisioningArtifactsForServiceAction(ctx context.Context, params *ListProvisioningArtifactsForServiceActionInput, ...) (*ListProvisioningArtifactsForServiceActionOutput, error)
- func (c *Client) ListRecordHistory(ctx context.Context, params *ListRecordHistoryInput, optFns ...func(*Options)) (*ListRecordHistoryOutput, error)
- func (c *Client) ListResourcesForTagOption(ctx context.Context, params *ListResourcesForTagOptionInput, ...) (*ListResourcesForTagOptionOutput, error)
- func (c *Client) ListServiceActions(ctx context.Context, params *ListServiceActionsInput, optFns ...func(*Options)) (*ListServiceActionsOutput, error)
- func (c *Client) ListServiceActionsForProvisioningArtifact(ctx context.Context, params *ListServiceActionsForProvisioningArtifactInput, ...) (*ListServiceActionsForProvisioningArtifactOutput, error)
- func (c *Client) ListStackInstancesForProvisionedProduct(ctx context.Context, params *ListStackInstancesForProvisionedProductInput, ...) (*ListStackInstancesForProvisionedProductOutput, error)
- func (c *Client) ListTagOptions(ctx context.Context, params *ListTagOptionsInput, optFns ...func(*Options)) (*ListTagOptionsOutput, error)
- func (c *Client) NotifyProvisionProductEngineWorkflowResult(ctx context.Context, params *NotifyProvisionProductEngineWorkflowResultInput, ...) (*NotifyProvisionProductEngineWorkflowResultOutput, error)
- func (c *Client) NotifyTerminateProvisionedProductEngineWorkflowResult(ctx context.Context, ...) (*NotifyTerminateProvisionedProductEngineWorkflowResultOutput, error)
- func (c *Client) NotifyUpdateProvisionedProductEngineWorkflowResult(ctx context.Context, ...) (*NotifyUpdateProvisionedProductEngineWorkflowResultOutput, error)
- func (c *Client) Options() Options
- func (c *Client) ProvisionProduct(ctx context.Context, params *ProvisionProductInput, optFns ...func(*Options)) (*ProvisionProductOutput, error)
- func (c *Client) RejectPortfolioShare(ctx context.Context, params *RejectPortfolioShareInput, ...) (*RejectPortfolioShareOutput, error)
- func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvisionedProductsInput, ...) (*ScanProvisionedProductsOutput, error)
- func (c *Client) SearchProducts(ctx context.Context, params *SearchProductsInput, optFns ...func(*Options)) (*SearchProductsOutput, error)
- func (c *Client) SearchProductsAsAdmin(ctx context.Context, params *SearchProductsAsAdminInput, ...) (*SearchProductsAsAdminOutput, error)
- func (c *Client) SearchProvisionedProducts(ctx context.Context, params *SearchProvisionedProductsInput, ...) (*SearchProvisionedProductsOutput, error)
- func (c *Client) TerminateProvisionedProduct(ctx context.Context, params *TerminateProvisionedProductInput, ...) (*TerminateProvisionedProductOutput, error)
- func (c *Client) UpdateConstraint(ctx context.Context, params *UpdateConstraintInput, optFns ...func(*Options)) (*UpdateConstraintOutput, error)
- func (c *Client) UpdatePortfolio(ctx context.Context, params *UpdatePortfolioInput, optFns ...func(*Options)) (*UpdatePortfolioOutput, error)
- func (c *Client) UpdatePortfolioShare(ctx context.Context, params *UpdatePortfolioShareInput, ...) (*UpdatePortfolioShareOutput, error)
- func (c *Client) UpdateProduct(ctx context.Context, params *UpdateProductInput, optFns ...func(*Options)) (*UpdateProductOutput, error)
- func (c *Client) UpdateProvisionedProduct(ctx context.Context, params *UpdateProvisionedProductInput, ...) (*UpdateProvisionedProductOutput, error)
- func (c *Client) UpdateProvisionedProductProperties(ctx context.Context, params *UpdateProvisionedProductPropertiesInput, ...) (*UpdateProvisionedProductPropertiesOutput, error)
- func (c *Client) UpdateProvisioningArtifact(ctx context.Context, params *UpdateProvisioningArtifactInput, ...) (*UpdateProvisioningArtifactOutput, error)
- func (c *Client) UpdateServiceAction(ctx context.Context, params *UpdateServiceActionInput, ...) (*UpdateServiceActionOutput, error)
- func (c *Client) UpdateTagOption(ctx context.Context, params *UpdateTagOptionInput, optFns ...func(*Options)) (*UpdateTagOptionOutput, error)
- type CopyProductInput
- type CopyProductOutput
- type CreateConstraintInput
- type CreateConstraintOutput
- type CreatePortfolioInput
- type CreatePortfolioOutput
- type CreatePortfolioShareInput
- type CreatePortfolioShareOutput
- type CreateProductInput
- type CreateProductOutput
- type CreateProvisionedProductPlanInput
- type CreateProvisionedProductPlanOutput
- type CreateProvisioningArtifactInput
- type CreateProvisioningArtifactOutput
- type CreateServiceActionInput
- type CreateServiceActionOutput
- type CreateTagOptionInput
- type CreateTagOptionOutput
- type DeleteConstraintInput
- type DeleteConstraintOutput
- type DeletePortfolioInput
- type DeletePortfolioOutput
- type DeletePortfolioShareInput
- type DeletePortfolioShareOutput
- type DeleteProductInput
- type DeleteProductOutput
- type DeleteProvisionedProductPlanInput
- type DeleteProvisionedProductPlanOutput
- type DeleteProvisioningArtifactInput
- type DeleteProvisioningArtifactOutput
- type DeleteServiceActionInput
- type DeleteServiceActionOutput
- type DeleteTagOptionInput
- type DeleteTagOptionOutput
- type DescribeConstraintInput
- type DescribeConstraintOutput
- type DescribeCopyProductStatusInput
- type DescribeCopyProductStatusOutput
- type DescribePortfolioInput
- type DescribePortfolioOutput
- type DescribePortfolioShareStatusInput
- type DescribePortfolioShareStatusOutput
- type DescribePortfolioSharesAPIClient
- type DescribePortfolioSharesInput
- type DescribePortfolioSharesOutput
- type DescribePortfolioSharesPaginator
- type DescribePortfolioSharesPaginatorOptions
- type DescribeProductAsAdminInput
- type DescribeProductAsAdminOutput
- type DescribeProductInput
- type DescribeProductOutput
- type DescribeProductViewInput
- type DescribeProductViewOutput
- type DescribeProvisionedProductInput
- type DescribeProvisionedProductOutput
- type DescribeProvisionedProductPlanInput
- type DescribeProvisionedProductPlanOutput
- type DescribeProvisioningArtifactInput
- type DescribeProvisioningArtifactOutput
- type DescribeProvisioningParametersInput
- type DescribeProvisioningParametersOutput
- type DescribeRecordInput
- type DescribeRecordOutput
- type DescribeServiceActionExecutionParametersInput
- type DescribeServiceActionExecutionParametersOutput
- type DescribeServiceActionInput
- type DescribeServiceActionOutput
- type DescribeTagOptionInput
- type DescribeTagOptionOutput
- type DisableAWSOrganizationsAccessInput
- type DisableAWSOrganizationsAccessOutput
- type DisassociateBudgetFromResourceInput
- type DisassociateBudgetFromResourceOutput
- type DisassociatePrincipalFromPortfolioInput
- type DisassociatePrincipalFromPortfolioOutput
- type DisassociateProductFromPortfolioInput
- type DisassociateProductFromPortfolioOutput
- type DisassociateServiceActionFromProvisioningArtifactInput
- type DisassociateServiceActionFromProvisioningArtifactOutput
- type DisassociateTagOptionFromResourceInput
- type DisassociateTagOptionFromResourceOutput
- type EnableAWSOrganizationsAccessInput
- type EnableAWSOrganizationsAccessOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type ExecuteProvisionedProductPlanInput
- type ExecuteProvisionedProductPlanOutput
- type ExecuteProvisionedProductServiceActionInput
- type ExecuteProvisionedProductServiceActionOutput
- type GetAWSOrganizationsAccessStatusInput
- type GetAWSOrganizationsAccessStatusOutput
- type GetProvisionedProductOutputsAPIClient
- type GetProvisionedProductOutputsInput
- type GetProvisionedProductOutputsOutput
- type GetProvisionedProductOutputsPaginator
- type GetProvisionedProductOutputsPaginatorOptions
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ImportAsProvisionedProductInput
- type ImportAsProvisionedProductOutput
- type ListAcceptedPortfolioSharesAPIClient
- type ListAcceptedPortfolioSharesInput
- type ListAcceptedPortfolioSharesOutput
- type ListAcceptedPortfolioSharesPaginator
- type ListAcceptedPortfolioSharesPaginatorOptions
- type ListBudgetsForResourceAPIClient
- type ListBudgetsForResourceInput
- type ListBudgetsForResourceOutput
- type ListBudgetsForResourcePaginator
- type ListBudgetsForResourcePaginatorOptions
- type ListConstraintsForPortfolioAPIClient
- type ListConstraintsForPortfolioInput
- type ListConstraintsForPortfolioOutput
- type ListConstraintsForPortfolioPaginator
- type ListConstraintsForPortfolioPaginatorOptions
- type ListLaunchPathsAPIClient
- type ListLaunchPathsInput
- type ListLaunchPathsOutput
- type ListLaunchPathsPaginator
- type ListLaunchPathsPaginatorOptions
- type ListOrganizationPortfolioAccessAPIClient
- type ListOrganizationPortfolioAccessInput
- type ListOrganizationPortfolioAccessOutput
- type ListOrganizationPortfolioAccessPaginator
- type ListOrganizationPortfolioAccessPaginatorOptions
- type ListPortfolioAccessAPIClient
- type ListPortfolioAccessInput
- type ListPortfolioAccessOutput
- type ListPortfolioAccessPaginator
- type ListPortfolioAccessPaginatorOptions
- type ListPortfoliosAPIClient
- type ListPortfoliosForProductAPIClient
- type ListPortfoliosForProductInput
- type ListPortfoliosForProductOutput
- type ListPortfoliosForProductPaginator
- type ListPortfoliosForProductPaginatorOptions
- type ListPortfoliosInput
- type ListPortfoliosOutput
- type ListPortfoliosPaginator
- type ListPortfoliosPaginatorOptions
- type ListPrincipalsForPortfolioAPIClient
- type ListPrincipalsForPortfolioInput
- type ListPrincipalsForPortfolioOutput
- type ListPrincipalsForPortfolioPaginator
- type ListPrincipalsForPortfolioPaginatorOptions
- type ListProvisionedProductPlansInput
- type ListProvisionedProductPlansOutput
- type ListProvisioningArtifactsForServiceActionAPIClient
- type ListProvisioningArtifactsForServiceActionInput
- type ListProvisioningArtifactsForServiceActionOutput
- type ListProvisioningArtifactsForServiceActionPaginator
- type ListProvisioningArtifactsForServiceActionPaginatorOptions
- type ListProvisioningArtifactsInput
- type ListProvisioningArtifactsOutput
- type ListRecordHistoryInput
- type ListRecordHistoryOutput
- type ListResourcesForTagOptionAPIClient
- type ListResourcesForTagOptionInput
- type ListResourcesForTagOptionOutput
- type ListResourcesForTagOptionPaginator
- type ListResourcesForTagOptionPaginatorOptions
- type ListServiceActionsAPIClient
- type ListServiceActionsForProvisioningArtifactAPIClient
- type ListServiceActionsForProvisioningArtifactInput
- type ListServiceActionsForProvisioningArtifactOutput
- type ListServiceActionsForProvisioningArtifactPaginator
- type ListServiceActionsForProvisioningArtifactPaginatorOptions
- type ListServiceActionsInput
- type ListServiceActionsOutput
- type ListServiceActionsPaginator
- type ListServiceActionsPaginatorOptions
- type ListStackInstancesForProvisionedProductInput
- type ListStackInstancesForProvisionedProductOutput
- type ListTagOptionsAPIClient
- type ListTagOptionsInput
- type ListTagOptionsOutput
- type ListTagOptionsPaginator
- type ListTagOptionsPaginatorOptions
- type NotifyProvisionProductEngineWorkflowResultInput
- type NotifyProvisionProductEngineWorkflowResultOutput
- type NotifyTerminateProvisionedProductEngineWorkflowResultInput
- type NotifyTerminateProvisionedProductEngineWorkflowResultOutput
- type NotifyUpdateProvisionedProductEngineWorkflowResultInput
- type NotifyUpdateProvisionedProductEngineWorkflowResultOutput
- type Options
- type ProvisionProductInput
- type ProvisionProductOutput
- type RejectPortfolioShareInput
- type RejectPortfolioShareOutput
- type ResolveEndpoint
- type ScanProvisionedProductsInput
- type ScanProvisionedProductsOutput
- type SearchProductsAPIClient
- type SearchProductsAsAdminAPIClient
- type SearchProductsAsAdminInput
- type SearchProductsAsAdminOutput
- type SearchProductsAsAdminPaginator
- type SearchProductsAsAdminPaginatorOptions
- type SearchProductsInput
- type SearchProductsOutput
- type SearchProductsPaginator
- type SearchProductsPaginatorOptions
- type SearchProvisionedProductsAPIClient
- type SearchProvisionedProductsInput
- type SearchProvisionedProductsOutput
- type SearchProvisionedProductsPaginator
- type SearchProvisionedProductsPaginatorOptions
- type TerminateProvisionedProductInput
- type TerminateProvisionedProductOutput
- type UpdateConstraintInput
- type UpdateConstraintOutput
- type UpdatePortfolioInput
- type UpdatePortfolioOutput
- type UpdatePortfolioShareInput
- type UpdatePortfolioShareOutput
- type UpdateProductInput
- type UpdateProductOutput
- type UpdateProvisionedProductInput
- type UpdateProvisionedProductOutput
- type UpdateProvisionedProductPropertiesInput
- type UpdateProvisionedProductPropertiesOutput
- type UpdateProvisioningArtifactInput
- type UpdateProvisioningArtifactOutput
- type UpdateServiceActionInput
- type UpdateServiceActionOutput
- type UpdateTagOptionInput
- type UpdateTagOptionOutput
Constants ¶
const ServiceAPIVersion = "2015-12-10"
const ServiceID = "Service Catalog"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.20.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.24.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.24.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AcceptPortfolioShareInput ¶
type AcceptPortfolioShareInput struct { // // This member is required. PortfolioId *string // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // portfolios. // // - AWS_ORGANIZATIONS - Accept portfolios shared by the management account of // your organization. // // - IMPORTED - Accept imported portfolios. // // - AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) // // For example, aws servicecatalog accept-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType // contains filtered or unexported fields }
type AcceptPortfolioShareOutput ¶
type AcceptPortfolioShareOutput struct { middleware.Metadata // contains filtered or unexported fields }ResultMetadata
type AssociateBudgetWithResourceInput ¶
type AssociateBudgetWithResourceInput struct { // The name of the budget you want to associate. // // This member is required. BudgetName *string // The resource identifier. Either a portfolio-id or a product-id. // // This member is required. ResourceId *string // contains filtered or unexported fields }
type AssociateBudgetWithResourceOutput ¶
type AssociateBudgetWithResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociatePrincipalWithPortfolioInput ¶
type AssociatePrincipalWithPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The ARN of the principal (user, role, or group). If the PrincipalType is IAM , // the supported value is a fully defined [IAM Amazon Resource Name (ARN)]. If the PrincipalType is IAM_PATTERN , // the supported value is an IAM ARN without an AccountID in the following format: // // arn:partition:iam:::resource-type/resource-id // // The ARN resource-id can be either: // // - A fully formed resource-id. For example, arn:aws:iam:::role/resource-name // or arn:aws:iam:::role/resource-path/resource-name // // - A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or // "?" in the resource-id segment of the ARN. For example // arn:partition:service:::resource-type/resource-path/resource-name. The new // symbols are exclusive to the resource-path and resource-name and cannot replace // the resource-type or other ARN values. // // The ARN path and principal name allow unlimited wildcard characters. // // Examples of an acceptable wildcard ARN: // // - arn:aws:iam:::role/ResourceName_* // // - arn:aws:iam:::role/*/ResourceName_? // // Examples of an unacceptable wildcard ARN: // // - arn:aws:iam:::*/ResourceName // // You can associate multiple IAM_PATTERN s even if the account has no principal // with that name. // // The "?" wildcard character matches zero or one of any character. This is // similar to ".?" in regular regex context. The "*" wildcard character matches any // number of any characters. This is similar to ".*" in regular regex context. // // In the IAM Principal ARN format // (arn:partition:iam:::resource-type/resource-path/resource-name), valid // resource-type values include user/, group/, or role/. The "?" and "*" characters // are allowed only after the resource-type in the resource-id segment. You can use // special characters anywhere within the resource-id. // // The "*" character also matches the "/" character, allowing paths to be formed // within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches // both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and // arn:aws:iam:::role/pathA/ResourceName_1. // // [IAM Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns // // This member is required. PrincipalARN *string // The principal type. The supported value is IAM if you use a fully defined // Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID , // with or without wildcard characters. // // This member is required. PrincipalType types.PrincipalType // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type AssociatePrincipalWithPortfolioOutput ¶
type AssociatePrincipalWithPortfolioOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateProductWithPortfolioInput ¶
type AssociateProductWithPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The product identifier. // // This member is required. ProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The identifier of the source portfolio. SourcePortfolioId *string // contains filtered or unexported fields }
type AssociateProductWithPortfolioOutput ¶
type AssociateProductWithPortfolioOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateServiceActionWithProvisioningArtifactInput ¶
type AssociateServiceActionWithProvisioningArtifactInput struct { // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // A unique identifier that you provide to ensure idempotency. If multiple // requests from the same Amazon Web Services account use the same idempotency // token, the same response is returned for each repeated request. IdempotencyToken *string // contains filtered or unexported fields }
type AssociateServiceActionWithProvisioningArtifactOutput ¶
type AssociateServiceActionWithProvisioningArtifactOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateTagOptionWithResourceOutput ¶
type AssociateTagOptionWithResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.24.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.24.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchAssociateServiceActionWithProvisioningArtifactInput ¶
type BatchAssociateServiceActionWithProvisioningArtifactInput struct { // One or more associations, each consisting of the Action ID, the Product ID, and // the Provisioning Artifact ID. // // This member is required. ServiceActionAssociations []types.ServiceActionAssociation // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type BatchAssociateServiceActionWithProvisioningArtifactOutput ¶
type BatchAssociateServiceActionWithProvisioningArtifactOutput struct { // An object that contains a list of errors, along with information to help you // identify the self-service action. FailedServiceActionAssociations []types.FailedServiceActionAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type BatchDisassociateServiceActionFromProvisioningArtifactInput ¶
type BatchDisassociateServiceActionFromProvisioningArtifactInput struct { // One or more associations, each consisting of the Action ID, the Product ID, and // the Provisioning Artifact ID. // // This member is required. ServiceActionAssociations []types.ServiceActionAssociation // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type BatchDisassociateServiceActionFromProvisioningArtifactOutput ¶
type BatchDisassociateServiceActionFromProvisioningArtifactOutput struct { // An object that contains a list of errors, along with information to help you // identify the self-service action. FailedServiceActionAssociations []types.FailedServiceActionAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Service Catalog.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AcceptPortfolioShare ¶
func (c *Client) AcceptPortfolioShare(ctx context.Context, params *AcceptPortfolioShareInput, optFns ...func(*Options)) (*AcceptPortfolioShareOutput, error)
Accepts an offer to share the specified portfolio.
func (*Client) AssociateBudgetWithResource ¶
func (c *Client) AssociateBudgetWithResource(ctx context.Context, params *AssociateBudgetWithResourceInput, optFns ...func(*Options)) (*AssociateBudgetWithResourceOutput, error)
Associates the specified budget with the specified resource.
func (*Client) AssociatePrincipalWithPortfolio ¶
func (c *Client) AssociatePrincipalWithPortfolio(ctx context.Context, params *AssociatePrincipalWithPortfolioInput, optFns ...func(*Options)) (*AssociatePrincipalWithPortfolioOutput, error)
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.
The PortfolioID , PrincipalARN , and PrincipalType parameters are required.
You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN .
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM . With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
func (*Client) AssociateProductWithPortfolio ¶
func (c *Client) AssociateProductWithPortfolio(ctx context.Context, params *AssociateProductWithPortfolioInput, optFns ...func(*Options)) (*AssociateProductWithPortfolioOutput, error)
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
func (*Client) AssociateServiceActionWithProvisioningArtifact ¶
func (c *Client) AssociateServiceActionWithProvisioningArtifact(ctx context.Context, params *AssociateServiceActionWithProvisioningArtifactInput, optFns ...func(*Options)) (*AssociateServiceActionWithProvisioningArtifactOutput, error)
Associates a self-service action with a provisioning artifact.
func (*Client) AssociateTagOptionWithResource ¶
func (c *Client) AssociateTagOptionWithResource(ctx context.Context, params *AssociateTagOptionWithResourceInput, optFns ...func(*Options)) (*AssociateTagOptionWithResourceOutput, error)
Associate the specified TagOption with the specified portfolio or product.
func (*Client) BatchAssociateServiceActionWithProvisioningArtifact ¶
func (c *Client) BatchAssociateServiceActionWithProvisioningArtifact(ctx context.Context, params *BatchAssociateServiceActionWithProvisioningArtifactInput, optFns ...func(*Options)) (*BatchAssociateServiceActionWithProvisioningArtifactOutput, error)
Associates multiple self-service actions with provisioning artifacts.
func (*Client) BatchDisassociateServiceActionFromProvisioningArtifact ¶
func (c *Client) BatchDisassociateServiceActionFromProvisioningArtifact(ctx context.Context, params *BatchDisassociateServiceActionFromProvisioningArtifactInput, optFns ...func(*Options)) (*BatchDisassociateServiceActionFromProvisioningArtifactOutput, error)
Disassociates a batch of self-service actions from the specified provisioning artifact.
func (*Client) CopyProduct ¶
func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optFns ...func(*Options)) (*CopyProductOutput, error)
Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
func (*Client) CreateConstraint ¶
func (c *Client) CreateConstraint(ctx context.Context, params *CreateConstraintInput, optFns ...func(*Options)) (*CreateConstraintOutput, error)
Creates a constraint.
A delegated admin is authorized to invoke this command.
func (*Client) CreatePortfolio ¶
func (c *Client) CreatePortfolio(ctx context.Context, params *CreatePortfolioInput, optFns ...func(*Options)) (*CreatePortfolioOutput, error)
Creates a portfolio.
A delegated admin is authorized to invoke this command.
func (*Client) CreatePortfolioShare ¶
func (c *Client) CreatePortfolioShare(ctx context.Context, params *CreatePortfolioShareInput, optFns ...func(*Options)) (*CreatePortfolioShareOutput, error)
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM . With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
func (*Client) CreateProduct ¶
func (c *Client) CreateProduct(ctx context.Context, params *CreateProductInput, optFns ...func(*Options)) (*CreateProductOutput, error)
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
func (*Client) CreateProvisionedProductPlan ¶
func (c *Client) CreateProvisionedProductPlan(ctx context.Context, params *CreateProvisionedProductPlanInput, optFns ...func(*Options)) (*CreateProvisionedProductPlanOutput, error)
Creates a plan.
A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
func (*Client) CreateProvisioningArtifact ¶
func (c *Client) CreateProvisioningArtifact(ctx context.Context, params *CreateProvisioningArtifactInput, optFns ...func(*Options)) (*CreateProvisioningArtifactOutput, error)
Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
func (*Client) CreateServiceAction ¶
func (c *Client) CreateServiceAction(ctx context.Context, params *CreateServiceActionInput, optFns ...func(*Options)) (*CreateServiceActionOutput, error)
Creates a self-service action.
func (*Client) CreateTagOption ¶
func (c *Client) CreateTagOption(ctx context.Context, params *CreateTagOptionInput, optFns ...func(*Options)) (*CreateTagOptionOutput, error)
Creates a TagOption.
func (*Client) DeleteConstraint ¶
func (c *Client) DeleteConstraint(ctx context.Context, params *DeleteConstraintInput, optFns ...func(*Options)) (*DeleteConstraintOutput, error)
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
func (*Client) DeletePortfolio ¶
func (c *Client) DeletePortfolio(ctx context.Context, params *DeletePortfolioInput, optFns ...func(*Options)) (*DeletePortfolioOutput, error)
Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.
A delegated admin is authorized to invoke this command.
func (*Client) DeletePortfolioShare ¶
func (c *Client) DeletePortfolioShare(ctx context.Context, params *DeletePortfolioShareInput, optFns ...func(*Options)) (*DeletePortfolioShareOutput, error)
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.
func (*Client) DeleteProduct ¶
func (c *Client) DeleteProduct(ctx context.Context, params *DeleteProductInput, optFns ...func(*Options)) (*DeleteProductOutput, error)
Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.
A delegated admin is authorized to invoke this command.
func (*Client) DeleteProvisionedProductPlan ¶
func (c *Client) DeleteProvisionedProductPlan(ctx context.Context, params *DeleteProvisionedProductPlanInput, optFns ...func(*Options)) (*DeleteProvisionedProductPlanOutput, error)
Deletes the specified plan.
func (*Client) DeleteProvisioningArtifact ¶
func (c *Client) DeleteProvisioningArtifact(ctx context.Context, params *DeleteProvisioningArtifactInput, optFns ...func(*Options)) (*DeleteProvisioningArtifactOutput, error)
Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
func (*Client) DeleteServiceAction ¶
func (c *Client) DeleteServiceAction(ctx context.Context, params *DeleteServiceActionInput, optFns ...func(*Options)) (*DeleteServiceActionOutput, error)
Deletes a self-service action.
func (*Client) DeleteTagOption ¶
func (c *Client) DeleteTagOption(ctx context.Context, params *DeleteTagOptionInput, optFns ...func(*Options)) (*DeleteTagOptionOutput, error)
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
func (*Client) DescribeConstraint ¶
func (c *Client) DescribeConstraint(ctx context.Context, params *DescribeConstraintInput, optFns ...func(*Options)) (*DescribeConstraintOutput, error)
Gets information about the specified constraint.
func (*Client) DescribeCopyProductStatus ¶
func (c *Client) DescribeCopyProductStatus(ctx context.Context, params *DescribeCopyProductStatusInput, optFns ...func(*Options)) (*DescribeCopyProductStatusOutput, error)
Gets the status of the specified copy product operation.
func (*Client) DescribePortfolio ¶
func (c *Client) DescribePortfolio(ctx context.Context, params *DescribePortfolioInput, optFns ...func(*Options)) (*DescribePortfolioOutput, error)
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
func (*Client) DescribePortfolioShareStatus ¶
func (c *Client) DescribePortfolioShareStatus(ctx context.Context, params *DescribePortfolioShareStatusInput, optFns ...func(*Options)) (*DescribePortfolioShareStatusOutput, error)
Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
func (*Client) DescribePortfolioShares ¶ added in v0.31.0
func (c *Client) DescribePortfolioShares(ctx context.Context, params *DescribePortfolioSharesInput, optFns ...func(*Options)) (*DescribePortfolioSharesOutput, error)
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The PortfolioId and Type parameters are both required.
func (*Client) DescribeProduct ¶
func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInput, optFns ...func(*Options)) (*DescribeProductOutput, error)
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
func (*Client) DescribeProductAsAdmin ¶
func (c *Client) DescribeProductAsAdmin(ctx context.Context, params *DescribeProductAsAdminInput, optFns ...func(*Options)) (*DescribeProductAsAdminOutput, error)
Gets information about the specified product. This operation is run with administrator access.
func (*Client) DescribeProductView ¶
func (c *Client) DescribeProductView(ctx context.Context, params *DescribeProductViewInput, optFns ...func(*Options)) (*DescribeProductViewOutput, error)
Gets information about the specified product.
func (*Client) DescribeProvisionedProduct ¶
func (c *Client) DescribeProvisionedProduct(ctx context.Context, params *DescribeProvisionedProductInput, optFns ...func(*Options)) (*DescribeProvisionedProductOutput, error)
Gets information about the specified provisioned product.
func (*Client) DescribeProvisionedProductPlan ¶
func (c *Client) DescribeProvisionedProductPlan(ctx context.Context, params *DescribeProvisionedProductPlanInput, optFns ...func(*Options)) (*DescribeProvisionedProductPlanOutput, error)
Gets information about the resource changes for the specified plan.
func (*Client) DescribeProvisioningArtifact ¶
func (c *Client) DescribeProvisioningArtifact(ctx context.Context, params *DescribeProvisioningArtifactInput, optFns ...func(*Options)) (*DescribeProvisioningArtifactOutput, error)
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
func (*Client) DescribeProvisioningParameters ¶
func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *DescribeProvisioningParametersInput, optFns ...func(*Options)) (*DescribeProvisioningParametersOutput, error)
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId .
func (*Client) DescribeRecord ¶
func (c *Client) DescribeRecord(ctx context.Context, params *DescribeRecordInput, optFns ...func(*Options)) (*DescribeRecordOutput, error)
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistoryto see the product's history from when he was the owner.
func (*Client) DescribeServiceAction ¶
func (c *Client) DescribeServiceAction(ctx context.Context, params *DescribeServiceActionInput, optFns ...func(*Options)) (*DescribeServiceActionOutput, error)
Describes a self-service action.
func (*Client) DescribeServiceActionExecutionParameters ¶
func (c *Client) DescribeServiceActionExecutionParameters(ctx context.Context, params *DescribeServiceActionExecutionParametersInput, optFns ...func(*Options)) (*DescribeServiceActionExecutionParametersOutput, error)
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
func (*Client) DescribeTagOption ¶
func (c *Client) DescribeTagOption(ctx context.Context, params *DescribeTagOptionInput, optFns ...func(*Options)) (*DescribeTagOptionOutput, error)
Gets information about the specified TagOption.
func (*Client) DisableAWSOrganizationsAccess ¶
func (c *Client) DisableAWSOrganizationsAccess(ctx context.Context, params *DisableAWSOrganizationsAccessInput, optFns ...func(*Options)) (*DisableAWSOrganizationsAccessOutput, error)
Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess .
If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
func (*Client) DisassociateBudgetFromResource ¶
func (c *Client) DisassociateBudgetFromResource(ctx context.Context, params *DisassociateBudgetFromResourceInput, optFns ...func(*Options)) (*DisassociateBudgetFromResourceOutput, error)
Disassociates the specified budget from the specified resource.
func (*Client) DisassociatePrincipalFromPortfolio ¶
func (c *Client) DisassociatePrincipalFromPortfolio(ctx context.Context, params *DisassociatePrincipalFromPortfolioInput, optFns ...func(*Options)) (*DisassociatePrincipalFromPortfolioOutput, error)
Disassociates a previously associated principal ARN from a specified portfolio.
The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio .
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType as IAM , the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN . To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN , and then ensure you disassociate any IAM_PATTERN principals that match the principal whose access you are removing.
func (*Client) DisassociateProductFromPortfolio ¶
func (c *Client) DisassociateProductFromPortfolio(ctx context.Context, params *DisassociateProductFromPortfolioInput, optFns ...func(*Options)) (*DisassociateProductFromPortfolioOutput, error)
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
func (*Client) DisassociateServiceActionFromProvisioningArtifact ¶
func (c *Client) DisassociateServiceActionFromProvisioningArtifact(ctx context.Context, params *DisassociateServiceActionFromProvisioningArtifactInput, optFns ...func(*Options)) (*DisassociateServiceActionFromProvisioningArtifactOutput, error)
Disassociates the specified self-service action association from the specified provisioning artifact.
func (*Client) DisassociateTagOptionFromResource ¶
func (c *Client) DisassociateTagOptionFromResource(ctx context.Context, params *DisassociateTagOptionFromResourceInput, optFns ...func(*Options)) (*DisassociateTagOptionFromResourceOutput, error)
Disassociates the specified TagOption from the specified resource.
func (*Client) EnableAWSOrganizationsAccess ¶
func (c *Client) EnableAWSOrganizationsAccess(ctx context.Context, params *EnableAWSOrganizationsAccessInput, optFns ...func(*Options)) (*EnableAWSOrganizationsAccessOutput, error)
Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.
Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess .
If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
func (*Client) ExecuteProvisionedProductPlan ¶
func (c *Client) ExecuteProvisionedProductPlan(ctx context.Context, params *ExecuteProvisionedProductPlanInput, optFns ...func(*Options)) (*ExecuteProvisionedProductPlanOutput, error)
Provisions or modifies a product based on the resource changes for the specified plan.
func (*Client) ExecuteProvisionedProductServiceAction ¶
func (c *Client) ExecuteProvisionedProductServiceAction(ctx context.Context, params *ExecuteProvisionedProductServiceActionInput, optFns ...func(*Options)) (*ExecuteProvisionedProductServiceActionOutput, error)
Executes a self-service action against a provisioned product.
func (*Client) GetAWSOrganizationsAccessStatus ¶
func (c *Client) GetAWSOrganizationsAccessStatus(ctx context.Context, params *GetAWSOrganizationsAccessStatusInput, optFns ...func(*Options)) (*GetAWSOrganizationsAccessStatusOutput, error)
Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
func (*Client) GetProvisionedProductOutputs ¶ added in v0.29.0
func (c *Client) GetProvisionedProductOutputs(ctx context.Context, params *GetProvisionedProductOutputsInput, optFns ...func(*Options)) (*GetProvisionedProductOutputsOutput, error)
This API takes either a ProvisonedProductId or a ProvisionedProductName , along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
func (*Client) ImportAsProvisionedProduct ¶ added in v0.30.0
func (c *Client) ImportAsProvisionedProduct(ctx context.Context, params *ImportAsProvisionedProductInput, optFns ...func(*Options)) (*ImportAsProvisionedProductOutput, error)
Requests the import of a resource as an Service Catalog provisioned product
that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.
The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE , UPDATE_COMPLETE , UPDATE_ROLLBACK_COMPLETE , IMPORT_COMPLETE , and IMPORT_ROLLBACK_COMPLETE .
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product.
The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.
You can only import one provisioned product at a time. The product's CloudFormation stack must have the IMPORT_COMPLETE status before you import another.
func (*Client) ListAcceptedPortfolioShares ¶
func (c *Client) ListAcceptedPortfolioShares(ctx context.Context, params *ListAcceptedPortfolioSharesInput, optFns ...func(*Options)) (*ListAcceptedPortfolioSharesOutput, error)
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType , you can list portfolios for which organizational shares were accepted by this account.
func (*Client) ListBudgetsForResource ¶
func (c *Client) ListBudgetsForResource(ctx context.Context, params *ListBudgetsForResourceInput, optFns ...func(*Options)) (*ListBudgetsForResourceOutput, error)
Lists all the budgets associated to the specified resource.
func (*Client) ListConstraintsForPortfolio ¶
func (c *Client) ListConstraintsForPortfolio(ctx context.Context, params *ListConstraintsForPortfolioInput, optFns ...func(*Options)) (*ListConstraintsForPortfolioOutput, error)
Lists the constraints for the specified portfolio and product.
func (*Client) ListLaunchPaths ¶
func (c *Client) ListLaunchPaths(ctx context.Context, params *ListLaunchPathsInput, optFns ...func(*Options)) (*ListLaunchPathsOutput, error)
Lists the paths to the specified product. A path describes how the user gets
access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users accessin the Service Catalog User Guide.
func (*Client) ListOrganizationPortfolioAccess ¶
func (c *Client) ListOrganizationPortfolioAccess(ctx context.Context, params *ListOrganizationPortfolioAccessInput, optFns ...func(*Options)) (*ListOrganizationPortfolioAccessOutput, error)
Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
If a delegated admin is de-registered, they can no longer perform this operation.
func (*Client) ListPortfolioAccess ¶
func (c *Client) ListPortfolioAccess(ctx context.Context, params *ListPortfolioAccessInput, optFns ...func(*Options)) (*ListPortfolioAccessOutput, error)
Lists the account IDs that have access to the specified portfolio.
A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.
func (*Client) ListPortfolios ¶
func (c *Client) ListPortfolios(ctx context.Context, params *ListPortfoliosInput, optFns ...func(*Options)) (*ListPortfoliosOutput, error)
Lists all portfolios in the catalog.
func (*Client) ListPortfoliosForProduct ¶
func (c *Client) ListPortfoliosForProduct(ctx context.Context, params *ListPortfoliosForProductInput, optFns ...func(*Options)) (*ListPortfoliosForProductOutput, error)
Lists all portfolios that the specified product is associated with.
func (*Client) ListPrincipalsForPortfolio ¶
func (c *Client) ListPrincipalsForPortfolio(ctx context.Context, params *ListPrincipalsForPortfolioInput, optFns ...func(*Options)) (*ListPrincipalsForPortfolioOutput, error)
Lists all PrincipalARN s and corresponding PrincipalType s associated with the specified portfolio.
func (*Client) ListProvisionedProductPlans ¶
func (c *Client) ListProvisionedProductPlans(ctx context.Context, params *ListProvisionedProductPlansInput, optFns ...func(*Options)) (*ListProvisionedProductPlansOutput, error)
Lists the plans for the specified provisioned product or all plans to which the user has access.
func (*Client) ListProvisioningArtifacts ¶
func (c *Client) ListProvisioningArtifacts(ctx context.Context, params *ListProvisioningArtifactsInput, optFns ...func(*Options)) (*ListProvisioningArtifactsOutput, error)
Lists all provisioning artifacts (also known as versions) for the specified product.
func (*Client) ListProvisioningArtifactsForServiceAction ¶
func (c *Client) ListProvisioningArtifactsForServiceAction(ctx context.Context, params *ListProvisioningArtifactsForServiceActionInput, optFns ...func(*Options)) (*ListProvisioningArtifactsForServiceActionOutput, error)
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
func (*Client) ListRecordHistory ¶
func (c *Client) ListRecordHistory(ctx context.Context, params *ListRecordHistoryInput, optFns ...func(*Options)) (*ListRecordHistoryOutput, error)
Lists the specified requests or all performed requests.
func (*Client) ListResourcesForTagOption ¶
func (c *Client) ListResourcesForTagOption(ctx context.Context, params *ListResourcesForTagOptionInput, optFns ...func(*Options)) (*ListResourcesForTagOptionOutput, error)
Lists the resources associated with the specified TagOption.
func (*Client) ListServiceActions ¶
func (c *Client) ListServiceActions(ctx context.Context, params *ListServiceActionsInput, optFns ...func(*Options)) (*ListServiceActionsOutput, error)
Lists all self-service actions.
func (*Client) ListServiceActionsForProvisioningArtifact ¶
func (c *Client) ListServiceActionsForProvisioningArtifact(ctx context.Context, params *ListServiceActionsForProvisioningArtifactInput, optFns ...func(*Options)) (*ListServiceActionsForProvisioningArtifactOutput, error)
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
func (*Client) ListStackInstancesForProvisionedProduct ¶
func (c *Client) ListStackInstancesForProvisionedProduct(ctx context.Context, params *ListStackInstancesForProvisionedProductInput, optFns ...func(*Options)) (*ListStackInstancesForProvisionedProductOutput, error)
Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.
func (*Client) ListTagOptions ¶
func (c *Client) ListTagOptions(ctx context.Context, params *ListTagOptionsInput, optFns ...func(*Options)) (*ListTagOptionsOutput, error)
Lists the specified TagOptions or all TagOptions.
func (*Client) NotifyProvisionProductEngineWorkflowResult ¶ added in v1.17.0
func (c *Client) NotifyProvisionProductEngineWorkflowResult(ctx context.Context, params *NotifyProvisionProductEngineWorkflowResultInput, optFns ...func(*Options)) (*NotifyProvisionProductEngineWorkflowResultOutput, error)
Notifies the result of the provisioning engine execution.
func (*Client) NotifyTerminateProvisionedProductEngineWorkflowResult ¶ added in v1.17.0
func (c *Client) NotifyTerminateProvisionedProductEngineWorkflowResult(ctx context.Context, params *NotifyTerminateProvisionedProductEngineWorkflowResultInput, optFns ...func(*Options)) (*NotifyTerminateProvisionedProductEngineWorkflowResultOutput, error)
Notifies the result of the terminate engine execution.
func (*Client) NotifyUpdateProvisionedProductEngineWorkflowResult ¶ added in v1.17.0
func (c *Client) NotifyUpdateProvisionedProductEngineWorkflowResult(ctx context.Context, params *NotifyUpdateProvisionedProductEngineWorkflowResultInput, optFns ...func(*Options)) (*NotifyUpdateProvisionedProductEngineWorkflowResultOutput, error)
Notifies the result of the update engine execution.
func (*Client) Options ¶ added in v1.25.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) ProvisionProduct ¶
func (c *Client) ProvisionProduct(ctx context.Context, params *ProvisionProductInput, optFns ...func(*Options)) (*ProvisionProductOutput, error)
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users accessin the Service Catalog User Guide.
func (*Client) RejectPortfolioShare ¶
func (c *Client) RejectPortfolioShare(ctx context.Context, params *RejectPortfolioShareInput, optFns ...func(*Options)) (*RejectPortfolioShareOutput, error)
Rejects an offer to share the specified portfolio.
func (*Client) ScanProvisionedProducts ¶
func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvisionedProductsInput, optFns ...func(*Options)) (*ScanProvisionedProductsOutput, error)
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
func (*Client) SearchProducts ¶
func (c *Client) SearchProducts(ctx context.Context, params *SearchProductsInput, optFns ...func(*Options)) (*SearchProductsOutput, error)
Gets information about the products to which the caller has access.
func (*Client) SearchProductsAsAdmin ¶
func (c *Client) SearchProductsAsAdmin(ctx context.Context, params *SearchProductsAsAdminInput, optFns ...func(*Options)) (*SearchProductsAsAdminOutput, error)
Gets information about the products for the specified portfolio or all products.
func (*Client) SearchProvisionedProducts ¶
func (c *Client) SearchProvisionedProducts(ctx context.Context, params *SearchProvisionedProductsInput, optFns ...func(*Options)) (*SearchProvisionedProductsOutput, error)
Gets information about the provisioned products that meet the specified criteria.
func (*Client) TerminateProvisionedProduct ¶
func (c *Client) TerminateProvisionedProduct(ctx context.Context, params *TerminateProvisionedProductInput, optFns ...func(*Options)) (*TerminateProvisionedProductOutput, error)
Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
func (*Client) UpdateConstraint ¶
func (c *Client) UpdateConstraint(ctx context.Context, params *UpdateConstraintInput, optFns ...func(*Options)) (*UpdateConstraintOutput, error)
Updates the specified constraint.
func (*Client) UpdatePortfolio ¶
func (c *Client) UpdatePortfolio(ctx context.Context, params *UpdatePortfolioInput, optFns ...func(*Options)) (*UpdatePortfolioOutput, error)
Updates the specified portfolio.
You cannot update a product that was shared with you.
func (*Client) UpdatePortfolioShare ¶ added in v0.31.0
func (c *Client) UpdatePortfolioShare(ctx context.Context, params *UpdatePortfolioShareInput, optFns ...func(*Options)) (*UpdatePortfolioShareOutput, error)
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS , as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.
You must provide the accountId or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM . With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
func (*Client) UpdateProduct ¶
func (c *Client) UpdateProduct(ctx context.Context, params *UpdateProductInput, optFns ...func(*Options)) (*UpdateProductOutput, error)
Updates the specified product.
func (*Client) UpdateProvisionedProduct ¶
func (c *Client) UpdateProvisionedProduct(ctx context.Context, params *UpdateProvisionedProductInput, optFns ...func(*Options)) (*UpdateProvisionedProductOutput, error)
Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
func (*Client) UpdateProvisionedProductProperties ¶
func (c *Client) UpdateProvisionedProductProperties(ctx context.Context, params *UpdateProvisionedProductPropertiesInput, optFns ...func(*Options)) (*UpdateProvisionedProductPropertiesOutput, error)
Requests updates to the properties of the specified provisioned product.
func (*Client) UpdateProvisioningArtifact ¶
func (c *Client) UpdateProvisioningArtifact(ctx context.Context, params *UpdateProvisioningArtifactInput, optFns ...func(*Options)) (*UpdateProvisioningArtifactOutput, error)
Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
func (*Client) UpdateServiceAction ¶
func (c *Client) UpdateServiceAction(ctx context.Context, params *UpdateServiceActionInput, optFns ...func(*Options)) (*UpdateServiceActionOutput, error)
Updates a self-service action.
func (*Client) UpdateTagOption ¶
func (c *Client) UpdateTagOption(ctx context.Context, params *UpdateTagOptionInput, optFns ...func(*Options)) (*UpdateTagOptionOutput, error)
Updates the specified TagOption.
type CopyProductInput ¶
type CopyProductInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The Amazon Resource Name (ARN) of the source product. // // This member is required. SourceProductArn *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The copy options. If the value is CopyTags , the tags from the source product // are copied to the target product. CopyOptions []types.CopyOption // The identifiers of the provisioning artifacts (also known as versions) of the // product to copy. By default, all provisioning artifacts are copied. SourceProvisioningArtifactIdentifiers []map[string]string // The identifier of the target product. By default, a new product is created. TargetProductId *string // A name for the target product. The default is the name of the source product. TargetProductName *string // contains filtered or unexported fields }
type CopyProductOutput ¶
type CopyProductOutput struct { // The token to use to track the progress of the operation. CopyProductToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateConstraintInput ¶
type CreateConstraintInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The constraint parameters, in JSON format. The syntax depends on the constraint // type as follows: // // LAUNCH You are required to specify either the RoleArn or the LocalRoleName but // can't use both. // // Specify the RoleArn property as follows: // // {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} // // Specify the LocalRoleName property as follows: // // {"LocalRoleName": "SCBasicLaunchRole"} // // If you specify the LocalRoleName property, when an account uses the launch // constraint, the IAM role with that name in the account will be used. This allows // launch-role constraints to be account-agnostic so the administrator can create // fewer resources per shared account. // // The given role name must exist in the account used to create the launch // constraint and the account of the user who launches a product with this launch // constraint. // // You cannot have both a LAUNCH and a STACKSET constraint. // // You also cannot have more than one LAUNCH constraint on a product and portfolio. // // NOTIFICATION Specify the NotificationArns property as follows: // // {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} // // RESOURCE_UPDATE Specify the TagUpdatesOnProvisionedProduct property as follows: // // {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}} // // The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED // or NOT_ALLOWED . // // STACKSET Specify the Parameters property as follows: // // {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": // [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}} // // You cannot have both a LAUNCH and a STACKSET constraint. // // You also cannot have more than one STACKSET constraint on a product and // portfolio. // // Products with a STACKSET constraint will launch an CloudFormation stack set. // // TEMPLATE Specify the Rules property. For more information, see [Template Constraint Rules]. // // [Template Constraint Rules]: http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html // // This member is required. Parameters *string // The portfolio identifier. // // This member is required. PortfolioId *string // The product identifier. // // This member is required. ProductId *string // The type of constraint. // // - LAUNCH // // - NOTIFICATION // // - RESOURCE_UPDATE // // - STACKSET // // - TEMPLATE // // This member is required. Type *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The description of the constraint. Description *string // contains filtered or unexported fields }
type CreateConstraintOutput ¶
type CreateConstraintOutput struct { // Information about the constraint. ConstraintDetail *types.ConstraintDetail // The constraint parameters. ConstraintParameters *string // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreatePortfolioInput ¶
type CreatePortfolioInput struct { // The name to use for display purposes. // // This member is required. DisplayName *string // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The name of the portfolio provider. // // This member is required. ProviderName *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The description of the portfolio. Description *string // One or more tags. Tags []types.Tag // contains filtered or unexported fields }
type CreatePortfolioOutput ¶
type CreatePortfolioOutput struct { // Information about the portfolio. PortfolioDetail *types.PortfolioDetail // Information about the tags associated with the portfolio. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreatePortfolioShareInput ¶
type CreatePortfolioShareInput struct { // // This member is required. PortfolioId *string // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string AccountId *string // OrganizationNode , it creates PortfolioShare for all of the Amazon Web Services // accounts that are associated to the OrganizationNode . The output returns a // PortfolioShareToken , which enables the administrator to monitor the status of // the PortfolioShare creation process. OrganizationNode *types.OrganizationNode // of ORGANIZATION or ORGANIZATIONAL_UNIT . // // Enables or disables Principal sharing when creating the portfolio share. If you // do not provide this flag, principal sharing is disabled. // // When you enable Principal Name Sharing for a portfolio share, the share // recipient account end users with a principal that matches any of the associated // IAM patterns can provision products from the portfolio. Once shared, the share // recipient can view associations of PrincipalType : IAM_PATTERN on their // portfolio. You can create the principals in the recipient account before or // after creating the share. SharePrincipals bool // this flag is not provided, TagOptions sharing is disabled. ShareTagOptions bool // contains filtered or unexported fields }
type CreatePortfolioShareOutput ¶
type CreatePortfolioShareOutput struct { // shared to an organization node. PortfolioShareToken *string ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateProductInput ¶
type CreateProductInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The name of the product. // // This member is required. Name *string // The owner of the product. // // This member is required. Owner *string // The type of product. // // This member is required. ProductType types.ProductType // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The description of the product. Description *string // The distributor of the product. Distributor *string // The configuration of the provisioning artifact. ProvisioningArtifactParameters *types.ProvisioningArtifactProperties // Specifies connection details for the created product and syncs the product to // the connection source artifact. This automatically manages the product's // artifacts based on changes to the source. The SourceConnection parameter // consists of the following sub-fields. // // - Type // // - ConnectionParamters SourceConnection *types.SourceConnection // The support information about the product. SupportDescription *string // The contact email for product support. SupportEmail *string // The contact URL for product support. // // ^https?:\/\// / is the pattern used to validate SupportUrl. SupportUrl *string // One or more tags. Tags []types.Tag // contains filtered or unexported fields }
type CreateProductOutput ¶
type CreateProductOutput struct { // Information about the product view. ProductViewDetail *types.ProductViewDetail // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail // Information about the tags associated with the product. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateProvisionedProductPlanInput ¶
type CreateProvisionedProductPlanInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The name of the plan. // // This member is required. PlanName *string // The plan type. // // This member is required. PlanType types.ProvisionedProductPlanType // The product identifier. // // This member is required. ProductId *string // A user-friendly name for the provisioned product. This value must be unique for // the Amazon Web Services account and cannot be updated after the product is // provisioned. // // This member is required. ProvisionedProductName *string // The identifier of the provisioning artifact. // // This member is required. ProvisioningArtifactId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related // events. NotificationArns []string // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the // paths for a product, use ListLaunchPaths. PathId *string // Parameters specified by the administrator that are required for provisioning // the product. ProvisioningParameters []types.UpdateProvisioningParameter // One or more tags. // // If the plan is for an existing provisioned product, the product must have a // RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED // to allow tag updates. Tags []types.Tag // contains filtered or unexported fields }
type CreateProvisionedProductPlanOutput ¶
type CreateProvisionedProductPlanOutput struct { // The plan identifier. PlanId *string // The name of the plan. PlanName *string // The product identifier. ProvisionProductId *string // The user-friendly name of the provisioned product. ProvisionedProductName *string // The identifier of the provisioning artifact. ProvisioningArtifactId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateProvisioningArtifactInput ¶
type CreateProvisioningArtifactInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The configuration for the provisioning artifact. // // This member is required. Parameters *types.ProvisioningArtifactProperties // The product identifier. // // This member is required. ProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type CreateProvisioningArtifactOutput ¶
type CreateProvisioningArtifactOutput struct { // Specify the template source with one of the following options, but not both. // Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ]. // // Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON // format. // // LoadTemplateFromURL // // Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON // format. // // ImportFromPhysicalId // // Use the physical id of the resource that contains the template; currently // supports CloudFormation stack ARN. Info map[string]string // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateServiceActionInput ¶
type CreateServiceActionInput struct { // The self-service action definition. Can be one of the following: // // Name The name of the Amazon Web Services Systems Manager document (SSM // document). For example, AWS-RestartEC2Instance . // // If you are using a shared SSM document, you must provide the ARN instead of the // name. // // Version The Amazon Web Services Systems Manager automation document version. // For example, "Version": "1" // // AssumeRole The Amazon Resource Name (ARN) of the role that performs the // self-service actions on your behalf. For example, "AssumeRole": // "arn:aws:iam::12345678910:role/ActionRole" . // // To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE" // . // // Parameters The list of parameters in JSON format. // // For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or // [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}] . // // This member is required. Definition map[string]string // The service action definition type. For example, SSM_AUTOMATION . // // This member is required. DefinitionType types.ServiceActionDefinitionType // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The self-service action name. // // This member is required. Name *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The self-service action description. Description *string // contains filtered or unexported fields }
type CreateServiceActionOutput ¶
type CreateServiceActionOutput struct { // An object containing information about the self-service action. ServiceActionDetail *types.ServiceActionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateTagOptionInput ¶
type CreateTagOptionOutput ¶
type CreateTagOptionOutput struct { // Information about the TagOption. TagOptionDetail *types.TagOptionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteConstraintInput ¶
type DeleteConstraintOutput ¶
type DeleteConstraintOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePortfolioInput ¶
type DeletePortfolioOutput ¶
type DeletePortfolioOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePortfolioShareInput ¶
type DeletePortfolioShareInput struct { // // This member is required. PortfolioId *string // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string AccountId *string OrganizationNode *types.OrganizationNode // contains filtered or unexported fields }
type DeletePortfolioShareOutput ¶
type DeletePortfolioShareOutput struct { // made to an organization node. PortfolioShareToken *string ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteProductInput ¶
type DeleteProductOutput ¶
type DeleteProductOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteProvisionedProductPlanInput ¶
type DeleteProvisionedProductPlanInput struct { // The plan identifier. // // This member is required. PlanId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // If set to true, Service Catalog stops managing the specified provisioned // product even if it cannot delete the underlying resources. IgnoreErrors bool // contains filtered or unexported fields }
type DeleteProvisionedProductPlanOutput ¶
type DeleteProvisionedProductPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteProvisioningArtifactInput ¶
type DeleteProvisioningArtifactInput struct { // The product identifier. // // This member is required. ProductId *string // The identifier of the provisioning artifact. // // This member is required. ProvisioningArtifactId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type DeleteProvisioningArtifactOutput ¶
type DeleteProvisioningArtifactOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteServiceActionInput ¶
type DeleteServiceActionInput struct { // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // A unique identifier that you provide to ensure idempotency. If multiple // requests from the same Amazon Web Services account use the same idempotency // token, the same response is returned for each repeated request. IdempotencyToken *string // contains filtered or unexported fields }
type DeleteServiceActionOutput ¶
type DeleteServiceActionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteTagOptionInput ¶
type DeleteTagOptionInput struct { // The TagOption identifier. // // This member is required. Id *string // contains filtered or unexported fields }
type DeleteTagOptionOutput ¶
type DeleteTagOptionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeConstraintInput ¶
type DescribeConstraintOutput ¶
type DescribeConstraintOutput struct { // Information about the constraint. ConstraintDetail *types.ConstraintDetail // The constraint parameters. ConstraintParameters *string // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeCopyProductStatusInput ¶
type DescribeCopyProductStatusInput struct { // The token for the copy product operation. This token is returned by CopyProduct. // // This member is required. CopyProductToken *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type DescribeCopyProductStatusOutput ¶
type DescribeCopyProductStatusOutput struct { // The status of the copy product operation. CopyProductStatus types.CopyProductStatus // The status message. StatusDetail *string // The identifier of the copied product. TargetProductId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePortfolioInput ¶
type DescribePortfolioOutput ¶
type DescribePortfolioOutput struct { // Information about the associated budgets. Budgets []types.BudgetDetail // Information about the portfolio. PortfolioDetail *types.PortfolioDetail // Information about the TagOptions associated with the portfolio. TagOptions []types.TagOptionDetail // Information about the tags associated with the portfolio. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePortfolioShareStatusInput ¶
type DescribePortfolioShareStatusInput struct { // CreatePortfolioShare or by DeletePortfolioShare. // // This member is required. PortfolioShareToken *string // contains filtered or unexported fields }
type DescribePortfolioShareStatusOutput ¶
type DescribePortfolioShareStatusOutput struct { // id or organization id. OrganizationNodeValue *string PortfolioId *string PortfolioShareToken *string ShareDetails *types.ShareDetails Status types.ShareStatus ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePortfolioSharesAPIClient ¶ added in v0.31.0
type DescribePortfolioSharesAPIClient interface {
}DescribePortfolioSharesAPIClient is a client that implements the DescribePortfolioShares operation.
type DescribePortfolioSharesInput ¶ added in v0.31.0
type DescribePortfolioSharesInput struct { // // This member is required. PortfolioId *string // type of portfolio share, which can be one of the following: // // 1. ACCOUNT - Represents an external account to account share. // // 2. ORGANIZATION - Represents a share to an organization. This share is // available to every account in the organization. // // 3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit. // // 4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the // organization. // // This member is required. Type types.DescribePortfolioShareType PageSize int32 // results, use null. PageToken *string // contains filtered or unexported fields }
type DescribePortfolioSharesOutput ¶ added in v0.31.0
type DescribePortfolioSharesOutput struct { // additional results, this value is null. NextPageToken *string PortfolioShareDetails []types.PortfolioShareDetail ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePortfolioSharesPaginator ¶ added in v0.31.0
type DescribePortfolioSharesPaginator struct {
// contains filtered or unexported fields
}
DescribePortfolioSharesPaginator is a paginator for DescribePortfolioShares
func NewDescribePortfolioSharesPaginator ¶ added in v0.31.0
func NewDescribePortfolioSharesPaginator(client DescribePortfolioSharesAPIClient, params *DescribePortfolioSharesInput, optFns ...func(*DescribePortfolioSharesPaginatorOptions)) *DescribePortfolioSharesPaginator
NewDescribePortfolioSharesPaginator returns a new DescribePortfolioSharesPaginator
func (*DescribePortfolioSharesPaginator) HasMorePages ¶ added in v0.31.0
func (p *DescribePortfolioSharesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePortfolioSharesPaginator) NextPage ¶ added in v0.31.0
func (p *DescribePortfolioSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePortfolioSharesOutput, error)
NextPage retrieves the next DescribePortfolioShares page.
type DescribePortfolioSharesPaginatorOptions ¶ added in v0.31.0
type DescribePortfolioSharesPaginatorOptions struct { int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }Limit
DescribePortfolioSharesPaginatorOptions is the paginator options for DescribePortfolioShares
type DescribeProductAsAdminInput ¶
type DescribeProductAsAdminInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The product identifier. Id *string // The product name. Name *string // The unique identifier of the shared portfolio that the specified product is // associated with. // // You can provide this parameter to retrieve the shared TagOptions associated // with the product. If this parameter is provided and if TagOptions sharing is // enabled in the portfolio share, the API returns both local and shared TagOptions // associated with the product. Otherwise only local TagOptions will be returned. SourcePortfolioId *string // contains filtered or unexported fields }
type DescribeProductAsAdminOutput ¶
type DescribeProductAsAdminOutput struct { // Information about the associated budgets. Budgets []types.BudgetDetail // Information about the product view. ProductViewDetail *types.ProductViewDetail // Information about the provisioning artifacts (also known as versions) for the // specified product. ProvisioningArtifactSummaries []types.ProvisioningArtifactSummary // Information about the TagOptions associated with the product. TagOptions []types.TagOptionDetail // Information about the tags associated with the product. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProductInput ¶
type DescribeProductOutput ¶
type DescribeProductOutput struct { // Information about the associated budgets. Budgets []types.BudgetDetail // Information about the associated launch paths. LaunchPaths []types.LaunchPath // Summary information about the product view. ProductViewSummary *types.ProductViewSummary // Information about the provisioning artifacts for the specified product. ProvisioningArtifacts []types.ProvisioningArtifact // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProductViewOutput ¶
type DescribeProductViewOutput struct { // Summary information about the product. ProductViewSummary *types.ProductViewSummary // Information about the provisioning artifacts for the product. ProvisioningArtifacts []types.ProvisioningArtifact // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProvisionedProductInput ¶
type DescribeProvisionedProductInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The provisioned product identifier. You must provide the name or ID, but not // both. // // If you do not provide a name or ID, or you provide both name and ID, an // InvalidParametersException will occur. Id *string // The name of the provisioned product. You must provide the name or ID, but not // both. // // If you do not provide a name or ID, or you provide both name and ID, an // InvalidParametersException will occur. Name *string // contains filtered or unexported fields }
DescribeProvisionedProductAPI input structure.
AcceptLanguage - [Optional] The language code for localization.
Id - [Optional] The provisioned product identifier.
Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.
type DescribeProvisionedProductOutput ¶
type DescribeProvisionedProductOutput struct { // Any CloudWatch dashboards that were created when provisioning the product. CloudWatchDashboards []types.CloudWatchDashboard // Information about the provisioned product. ProvisionedProductDetail *types.ProvisionedProductDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProvisionedProductPlanInput ¶
type DescribeProvisionedProductPlanInput struct { // The plan identifier. // // This member is required. PlanId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type DescribeProvisionedProductPlanOutput ¶
type DescribeProvisionedProductPlanOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the plan. ProvisionedProductPlanDetails *types.ProvisionedProductPlanDetails // Information about the resource changes that will occur when the plan is // executed. ResourceChanges []types.ResourceChange // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProvisioningArtifactInput ¶
type DescribeProvisioningArtifactInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // Indicates if the API call response does or does not include additional details // about the provisioning parameters. IncludeProvisioningArtifactParameters bool // The product identifier. ProductId *string // The product name. ProductName *string // The identifier of the provisioning artifact. ProvisioningArtifactId *string // The provisioning artifact name. ProvisioningArtifactName *string // Indicates whether a verbose level of detail is enabled. Verbose bool // contains filtered or unexported fields }
type DescribeProvisioningArtifactOutput ¶
type DescribeProvisioningArtifactOutput struct { // The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Info map[string]string // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail // Information about the parameters used to provision the product. ProvisioningArtifactParameters []types.ProvisioningArtifactParameter // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProvisioningParametersInput ¶
type DescribeProvisioningParametersInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the // paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both. PathId *string // The name of the path. You must provide the name or ID, but not both. PathName *string // The product identifier. You must provide the product name or ID, but not both. ProductId *string // The name of the product. You must provide the name or ID, but not both. ProductName *string // The identifier of the provisioning artifact. You must provide the name or ID, // but not both. ProvisioningArtifactId *string // The name of the provisioning artifact. You must provide the name or ID, but not // both. ProvisioningArtifactName *string // contains filtered or unexported fields }
type DescribeProvisioningParametersOutput ¶
type DescribeProvisioningParametersOutput struct { // Information about the constraints used to provision the product. ConstraintSummaries []types.ConstraintSummary // A list of the keys and descriptions of the outputs. These outputs can be // referenced from a provisioned product launched from this provisioning artifact. ProvisioningArtifactOutputKeys []types.ProvisioningArtifactOutput // The output of the provisioning artifact. // // Deprecated: This property is deprecated and returns the Id and Description of // the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the // Keys and Descriptions of the outputs. ProvisioningArtifactOutputs []types.ProvisioningArtifactOutput // Information about the parameters used to provision the product. ProvisioningArtifactParameters []types.ProvisioningArtifactParameter // An object that contains information about preferences, such as Regions and // accounts, for the provisioning artifact. ProvisioningArtifactPreferences *types.ProvisioningArtifactPreferences // Information about the TagOptions associated with the resource. TagOptions []types.TagOptionSummary // Any additional metadata specifically related to the provisioning of the // product. For example, see the Version field of the CloudFormation template. UsageInstructions []types.UsageInstruction // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRecordInput ¶
type DescribeRecordInput struct { // The record identifier of the provisioned product. This identifier is returned // by the request operation. // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type DescribeRecordOutput ¶
type DescribeRecordOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the product. RecordDetail *types.RecordDetail // Information about the product created as the result of a request. For example, // the output for a CloudFormation-backed product that creates an S3 bucket would // include the S3 bucket URL. RecordOutputs []types.RecordOutput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeServiceActionExecutionParametersInput ¶
type DescribeServiceActionExecutionParametersInput struct { // The identifier of the provisioned product. // // This member is required. ProvisionedProductId *string // The self-service action identifier. // // This member is required. ServiceActionId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type DescribeServiceActionExecutionParametersOutput ¶
type DescribeServiceActionExecutionParametersOutput struct { // The parameters of the self-service action. ServiceActionParameters []types.ExecutionParameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeServiceActionOutput ¶
type DescribeServiceActionOutput struct { // Detailed information about the self-service action. ServiceActionDetail *types.ServiceActionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeTagOptionInput ¶
type DescribeTagOptionInput struct { // The TagOption identifier. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeTagOptionOutput ¶
type DescribeTagOptionOutput struct { // Information about the TagOption. TagOptionDetail *types.TagOptionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisableAWSOrganizationsAccessInput ¶
type DisableAWSOrganizationsAccessInput struct {
// contains filtered or unexported fields
}
type DisableAWSOrganizationsAccessOutput ¶
type DisableAWSOrganizationsAccessOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateBudgetFromResourceInput ¶
type DisassociateBudgetFromResourceInput struct { // The name of the budget you want to disassociate. // // This member is required. BudgetName *string // The resource identifier you want to disassociate from. Either a portfolio-id or // a product-id. // // This member is required. ResourceId *string // contains filtered or unexported fields }
type DisassociateBudgetFromResourceOutput ¶
type DisassociateBudgetFromResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociatePrincipalFromPortfolioInput ¶
type DisassociatePrincipalFromPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The ARN of the principal (user, role, or group). This field allows an ARN with // no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN // . // // This member is required. PrincipalARN *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if // you specify an IAM ARN with no AccountId, with or without wildcard characters. PrincipalType types.PrincipalType // contains filtered or unexported fields }
type DisassociatePrincipalFromPortfolioOutput ¶
type DisassociatePrincipalFromPortfolioOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateProductFromPortfolioInput ¶
type DisassociateProductFromPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The product identifier. // // This member is required. ProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type DisassociateProductFromPortfolioOutput ¶
type DisassociateProductFromPortfolioOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateServiceActionFromProvisioningArtifactInput ¶
type DisassociateServiceActionFromProvisioningArtifactInput struct { // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // A unique identifier that you provide to ensure idempotency. If multiple // requests from the same Amazon Web Services account use the same idempotency // token, the same response is returned for each repeated request. IdempotencyToken *string // contains filtered or unexported fields }
type DisassociateServiceActionFromProvisioningArtifactOutput ¶
type DisassociateServiceActionFromProvisioningArtifactOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateTagOptionFromResourceOutput ¶
type DisassociateTagOptionFromResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableAWSOrganizationsAccessInput ¶
type EnableAWSOrganizationsAccessInput struct {
// contains filtered or unexported fields
}
type EnableAWSOrganizationsAccessOutput ¶
type EnableAWSOrganizationsAccessOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.20.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.20.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.20.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.20.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.20.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type ExecuteProvisionedProductPlanInput ¶
type ExecuteProvisionedProductPlanInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The plan identifier. // // This member is required. PlanId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type ExecuteProvisionedProductPlanOutput ¶
type ExecuteProvisionedProductPlanOutput struct { // Information about the result of provisioning the product. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ExecuteProvisionedProductServiceActionInput ¶
type ExecuteProvisionedProductServiceActionInput struct { // An idempotency token that uniquely identifies the execute request. // // This member is required. ExecuteToken *string // The identifier of the provisioned product. // // This member is required. ProvisionedProductId *string // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // A map of all self-service action parameters and their values. If a provided // parameter is of a special type, such as TARGET , the provided value will // override the default value generated by Service Catalog. If the parameters field // is not provided, no additional parameters are passed and default values will be // used for any special parameters such as TARGET . Parameters map[string][]string // contains filtered or unexported fields }
type ExecuteProvisionedProductServiceActionOutput ¶
type ExecuteProvisionedProductServiceActionOutput struct { // An object containing detailed information about the result of provisioning the // product. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAWSOrganizationsAccessStatusInput ¶
type GetAWSOrganizationsAccessStatusInput struct {
// contains filtered or unexported fields
}
type GetAWSOrganizationsAccessStatusOutput ¶
type GetAWSOrganizationsAccessStatusOutput struct { // The status of the portfolio share feature. AccessStatus types.AccessStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetProvisionedProductOutputsAPIClient ¶ added in v0.30.0
type GetProvisionedProductOutputsAPIClient interface {
GetProvisionedProductOutputs(context.Context, *GetProvisionedProductOutputsInput, ...func(*Options)) (*GetProvisionedProductOutputsOutput, error)
}
GetProvisionedProductOutputsAPIClient is a client that implements the GetProvisionedProductOutputs operation.
type GetProvisionedProductOutputsInput ¶ added in v0.29.0
type GetProvisionedProductOutputsInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The list of keys that the API should return with their values. If none are // provided, the API will return all outputs of the provisioned product. OutputKeys []string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The identifier of the provisioned product that you want the outputs from. ProvisionedProductId *string // The name of the provisioned product that you want the outputs from. ProvisionedProductName *string // contains filtered or unexported fields }
type GetProvisionedProductOutputsOutput ¶ added in v0.29.0
type GetProvisionedProductOutputsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the product created as the result of a request. For example, // the output for a CloudFormation-backed product that creates an S3 bucket would // include the S3 bucket URL. Outputs []types.RecordOutput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetProvisionedProductOutputsPaginator ¶ added in v0.30.0
type GetProvisionedProductOutputsPaginator struct {
// contains filtered or unexported fields
}
GetProvisionedProductOutputsPaginator is a paginator for GetProvisionedProductOutputs
func NewGetProvisionedProductOutputsPaginator ¶ added in v0.30.0
func NewGetProvisionedProductOutputsPaginator(client GetProvisionedProductOutputsAPIClient, params *GetProvisionedProductOutputsInput, optFns ...func(*GetProvisionedProductOutputsPaginatorOptions)) *GetProvisionedProductOutputsPaginator
NewGetProvisionedProductOutputsPaginator returns a new GetProvisionedProductOutputsPaginator
func (*GetProvisionedProductOutputsPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetProvisionedProductOutputsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetProvisionedProductOutputsPaginator) NextPage ¶ added in v0.30.0
func (p *GetProvisionedProductOutputsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetProvisionedProductOutputsOutput, error)
NextPage retrieves the next GetProvisionedProductOutputs page.
type GetProvisionedProductOutputsPaginatorOptions ¶ added in v0.30.0
type GetProvisionedProductOutputsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetProvisionedProductOutputsPaginatorOptions is the paginator options for GetProvisionedProductOutputs
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ImportAsProvisionedProductInput ¶ added in v0.30.0
type ImportAsProvisionedProductInput struct { // A unique identifier that you provide to ensure idempotency. If multiple // requests differ only by the idempotency token, the same response is returned for // each repeated request. // // This member is required. IdempotencyToken *string // The unique identifier of the resource to be imported. It only currently // supports CloudFormation stack IDs. // // This member is required. PhysicalId *string // The product identifier. // // This member is required. ProductId *string // The user-friendly name of the provisioned product. The value must be unique for // the Amazon Web Services account. The name cannot be updated after the product is // provisioned. // // This member is required. ProvisionedProductName *string // The identifier of the provisioning artifact. // // This member is required. ProvisioningArtifactId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type ImportAsProvisionedProductOutput ¶ added in v0.30.0
type ImportAsProvisionedProductOutput struct { // Information about a request operation. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAcceptedPortfolioSharesAPIClient ¶ added in v0.30.0
type ListAcceptedPortfolioSharesAPIClient interface {
}ListAcceptedPortfolioSharesAPIClient is a client that implements the ListAcceptedPortfolioShares operation.
type ListAcceptedPortfolioSharesInput ¶
type ListAcceptedPortfolioSharesInput struct { // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string PageSize int32 // results, use null. PageToken *string // portfolios. // // - AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational // sharing by the management account or delegated administrator of your // organization. // // - AWS_SERVICECATALOG - Deprecated type. // // - IMPORTED - List imported portfolios that have been accepted and shared // through account-to-account sharing. PortfolioShareType types.PortfolioShareType // contains filtered or unexported fields }
type ListAcceptedPortfolioSharesOutput ¶
type ListAcceptedPortfolioSharesOutput struct { // additional results, this value is null. NextPageToken *string PortfolioDetails []types.PortfolioDetail ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAcceptedPortfolioSharesPaginator ¶ added in v0.30.0
type ListAcceptedPortfolioSharesPaginator struct {
// contains filtered or unexported fields
}
ListAcceptedPortfolioSharesPaginator is a paginator for ListAcceptedPortfolioShares
func NewListAcceptedPortfolioSharesPaginator ¶ added in v0.30.0
func NewListAcceptedPortfolioSharesPaginator(client ListAcceptedPortfolioSharesAPIClient, params *ListAcceptedPortfolioSharesInput, optFns ...func(*ListAcceptedPortfolioSharesPaginatorOptions)) *ListAcceptedPortfolioSharesPaginator
NewListAcceptedPortfolioSharesPaginator returns a new ListAcceptedPortfolioSharesPaginator
func (*ListAcceptedPortfolioSharesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListAcceptedPortfolioSharesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAcceptedPortfolioSharesPaginator) NextPage ¶ added in v0.30.0
func (p *ListAcceptedPortfolioSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAcceptedPortfolioSharesOutput, error)
NextPage retrieves the next ListAcceptedPortfolioShares page.
type ListAcceptedPortfolioSharesPaginatorOptions ¶ added in v0.30.0
type ListAcceptedPortfolioSharesPaginatorOptions struct { int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }Limit
ListAcceptedPortfolioSharesPaginatorOptions is the paginator options for ListAcceptedPortfolioShares
type ListBudgetsForResourceAPIClient ¶ added in v0.30.0
type ListBudgetsForResourceAPIClient interface {
ListBudgetsForResource(context.Context, *ListBudgetsForResourceInput, ...func(*Options)) (*ListBudgetsForResourceOutput, error)
}
ListBudgetsForResourceAPIClient is a client that implements the ListBudgetsForResource operation.
type ListBudgetsForResourceInput ¶
type ListBudgetsForResourceInput struct { // The resource identifier. // // This member is required. ResourceId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListBudgetsForResourceOutput ¶
type ListBudgetsForResourceOutput struct { // Information about the associated budgets. Budgets []types.BudgetDetail // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBudgetsForResourcePaginator ¶ added in v0.30.0
type ListBudgetsForResourcePaginator struct {
// contains filtered or unexported fields
}
ListBudgetsForResourcePaginator is a paginator for ListBudgetsForResource
func NewListBudgetsForResourcePaginator ¶ added in v0.30.0
func NewListBudgetsForResourcePaginator(client ListBudgetsForResourceAPIClient, params *ListBudgetsForResourceInput, optFns ...func(*ListBudgetsForResourcePaginatorOptions)) *ListBudgetsForResourcePaginator
NewListBudgetsForResourcePaginator returns a new ListBudgetsForResourcePaginator
func (*ListBudgetsForResourcePaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBudgetsForResourcePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBudgetsForResourcePaginator) NextPage ¶ added in v0.30.0
func (p *ListBudgetsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBudgetsForResourceOutput, error)
NextPage retrieves the next ListBudgetsForResource page.
type ListBudgetsForResourcePaginatorOptions ¶ added in v0.30.0
type ListBudgetsForResourcePaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBudgetsForResourcePaginatorOptions is the paginator options for ListBudgetsForResource
type ListConstraintsForPortfolioAPIClient ¶ added in v0.30.0
type ListConstraintsForPortfolioAPIClient interface {
ListConstraintsForPortfolio(context.Context, *ListConstraintsForPortfolioInput, ...func(*Options)) (*ListConstraintsForPortfolioOutput, error)
}
ListConstraintsForPortfolioAPIClient is a client that implements the ListConstraintsForPortfolio operation.
type ListConstraintsForPortfolioInput ¶
type ListConstraintsForPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The product identifier. ProductId *string // contains filtered or unexported fields }
type ListConstraintsForPortfolioOutput ¶
type ListConstraintsForPortfolioOutput struct { // Information about the constraints. ConstraintDetails []types.ConstraintDetail // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListConstraintsForPortfolioPaginator ¶ added in v0.30.0
type ListConstraintsForPortfolioPaginator struct {
// contains filtered or unexported fields
}
ListConstraintsForPortfolioPaginator is a paginator for ListConstraintsForPortfolio
func NewListConstraintsForPortfolioPaginator ¶ added in v0.30.0
func NewListConstraintsForPortfolioPaginator(client ListConstraintsForPortfolioAPIClient, params *ListConstraintsForPortfolioInput, optFns ...func(*ListConstraintsForPortfolioPaginatorOptions)) *ListConstraintsForPortfolioPaginator
NewListConstraintsForPortfolioPaginator returns a new ListConstraintsForPortfolioPaginator
func (*ListConstraintsForPortfolioPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListConstraintsForPortfolioPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListConstraintsForPortfolioPaginator) NextPage ¶ added in v0.30.0
func (p *ListConstraintsForPortfolioPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConstraintsForPortfolioOutput, error)
NextPage retrieves the next ListConstraintsForPortfolio page.
type ListConstraintsForPortfolioPaginatorOptions ¶ added in v0.30.0
type ListConstraintsForPortfolioPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListConstraintsForPortfolioPaginatorOptions is the paginator options for ListConstraintsForPortfolio
type ListLaunchPathsAPIClient ¶ added in v0.30.0
type ListLaunchPathsAPIClient interface {
ListLaunchPaths(context.Context, *ListLaunchPathsInput, ...func(*Options)) (*ListLaunchPathsOutput, error)
}
ListLaunchPathsAPIClient is a client that implements the ListLaunchPaths operation.
type ListLaunchPathsInput ¶
type ListLaunchPathsInput struct { // The product identifier. // // This member is required. ProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListLaunchPathsOutput ¶
type ListLaunchPathsOutput struct { // Information about the launch path. LaunchPathSummaries []types.LaunchPathSummary // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListLaunchPathsPaginator ¶ added in v0.30.0
type ListLaunchPathsPaginator struct {
// contains filtered or unexported fields
}
ListLaunchPathsPaginator is a paginator for ListLaunchPaths
func NewListLaunchPathsPaginator ¶ added in v0.30.0
func NewListLaunchPathsPaginator(client ListLaunchPathsAPIClient, params *ListLaunchPathsInput, optFns ...func(*ListLaunchPathsPaginatorOptions)) *ListLaunchPathsPaginator
NewListLaunchPathsPaginator returns a new ListLaunchPathsPaginator
func (*ListLaunchPathsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListLaunchPathsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListLaunchPathsPaginator) NextPage ¶ added in v0.30.0
func (p *ListLaunchPathsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLaunchPathsOutput, error)
NextPage retrieves the next ListLaunchPaths page.
type ListLaunchPathsPaginatorOptions ¶ added in v0.30.0
type ListLaunchPathsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListLaunchPathsPaginatorOptions is the paginator options for ListLaunchPaths
type ListOrganizationPortfolioAccessAPIClient ¶ added in v0.30.0
type ListOrganizationPortfolioAccessAPIClient interface {
ListOrganizationPortfolioAccess(context.Context, *ListOrganizationPortfolioAccessInput, ...func(*Options)) (*ListOrganizationPortfolioAccessOutput, error)
}
ListOrganizationPortfolioAccessAPIClient is a client that implements the ListOrganizationPortfolioAccess operation.
type ListOrganizationPortfolioAccessInput ¶
type ListOrganizationPortfolioAccessInput struct { // The organization node type that will be returned in the output. // // - ORGANIZATION - Organization that has access to the portfolio. // // - ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio // within your organization. // // - ACCOUNT - Account that has access to the portfolio within your organization. // // This member is required. OrganizationNodeType types.OrganizationNodeType // The portfolio identifier. For example, port-2abcdext3y5fk . // // This member is required. PortfolioId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListOrganizationPortfolioAccessOutput ¶
type ListOrganizationPortfolioAccessOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Displays information about the organization nodes. OrganizationNodes []types.OrganizationNode // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOrganizationPortfolioAccessPaginator ¶ added in v0.30.0
type ListOrganizationPortfolioAccessPaginator struct {
// contains filtered or unexported fields
}
ListOrganizationPortfolioAccessPaginator is a paginator for ListOrganizationPortfolioAccess
func NewListOrganizationPortfolioAccessPaginator ¶ added in v0.30.0
func NewListOrganizationPortfolioAccessPaginator(client ListOrganizationPortfolioAccessAPIClient, params *ListOrganizationPortfolioAccessInput, optFns ...func(*ListOrganizationPortfolioAccessPaginatorOptions)) *ListOrganizationPortfolioAccessPaginator
NewListOrganizationPortfolioAccessPaginator returns a new ListOrganizationPortfolioAccessPaginator
func (*ListOrganizationPortfolioAccessPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListOrganizationPortfolioAccessPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOrganizationPortfolioAccessPaginator) NextPage ¶ added in v0.30.0
func (p *ListOrganizationPortfolioAccessPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationPortfolioAccessOutput, error)
NextPage retrieves the next ListOrganizationPortfolioAccess page.
type ListOrganizationPortfolioAccessPaginatorOptions ¶ added in v0.30.0
type ListOrganizationPortfolioAccessPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListOrganizationPortfolioAccessPaginatorOptions is the paginator options for ListOrganizationPortfolioAccess
type ListPortfolioAccessAPIClient ¶ added in v0.30.0
type ListPortfolioAccessAPIClient interface {
ListPortfolioAccess(context.Context, *ListPortfolioAccessInput, ...func(*Options)) (*ListPortfolioAccessOutput, error)
}
ListPortfolioAccessAPIClient is a client that implements the ListPortfolioAccess operation.
type ListPortfolioAccessInput ¶
type ListPortfolioAccessInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The ID of an organization node the portfolio is shared with. All children of // this node with an inherited portfolio share will be returned. OrganizationParentId *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListPortfolioAccessOutput ¶
type ListPortfolioAccessOutput struct { // Information about the Amazon Web Services accounts with access to the portfolio. AccountIds []string // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPortfolioAccessPaginator ¶ added in v0.30.0
type ListPortfolioAccessPaginator struct {
// contains filtered or unexported fields
}
ListPortfolioAccessPaginator is a paginator for ListPortfolioAccess
func NewListPortfolioAccessPaginator ¶ added in v0.30.0
func NewListPortfolioAccessPaginator(client ListPortfolioAccessAPIClient, params *ListPortfolioAccessInput, optFns ...func(*ListPortfolioAccessPaginatorOptions)) *ListPortfolioAccessPaginator
NewListPortfolioAccessPaginator returns a new ListPortfolioAccessPaginator
func (*ListPortfolioAccessPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListPortfolioAccessPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPortfolioAccessPaginator) NextPage ¶ added in v0.30.0
func (p *ListPortfolioAccessPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPortfolioAccessOutput, error)
NextPage retrieves the next ListPortfolioAccess page.
type ListPortfolioAccessPaginatorOptions ¶ added in v0.30.0
type ListPortfolioAccessPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPortfolioAccessPaginatorOptions is the paginator options for ListPortfolioAccess
type ListPortfoliosAPIClient ¶ added in v0.30.0
type ListPortfoliosAPIClient interface {
ListPortfolios(context.Context, *ListPortfoliosInput, ...func(*Options)) (*ListPortfoliosOutput, error)
}
ListPortfoliosAPIClient is a client that implements the ListPortfolios operation.
type ListPortfoliosForProductAPIClient ¶ added in v0.30.0
type ListPortfoliosForProductAPIClient interface {
ListPortfoliosForProduct(context.Context, *ListPortfoliosForProductInput, ...func(*Options)) (*ListPortfoliosForProductOutput, error)
}
ListPortfoliosForProductAPIClient is a client that implements the ListPortfoliosForProduct operation.
type ListPortfoliosForProductInput ¶
type ListPortfoliosForProductInput struct { // The product identifier. // // This member is required. ProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListPortfoliosForProductOutput ¶
type ListPortfoliosForProductOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the portfolios. PortfolioDetails []types.PortfolioDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPortfoliosForProductPaginator ¶ added in v0.30.0
type ListPortfoliosForProductPaginator struct {
// contains filtered or unexported fields
}
ListPortfoliosForProductPaginator is a paginator for ListPortfoliosForProduct
func NewListPortfoliosForProductPaginator ¶ added in v0.30.0
func NewListPortfoliosForProductPaginator(client ListPortfoliosForProductAPIClient, params *ListPortfoliosForProductInput, optFns ...func(*ListPortfoliosForProductPaginatorOptions)) *ListPortfoliosForProductPaginator
NewListPortfoliosForProductPaginator returns a new ListPortfoliosForProductPaginator
func (*ListPortfoliosForProductPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListPortfoliosForProductPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPortfoliosForProductPaginator) NextPage ¶ added in v0.30.0
func (p *ListPortfoliosForProductPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPortfoliosForProductOutput, error)
NextPage retrieves the next ListPortfoliosForProduct page.
type ListPortfoliosForProductPaginatorOptions ¶ added in v0.30.0
type ListPortfoliosForProductPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPortfoliosForProductPaginatorOptions is the paginator options for ListPortfoliosForProduct
type ListPortfoliosInput ¶
type ListPortfoliosInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListPortfoliosOutput ¶
type ListPortfoliosOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the portfolios. PortfolioDetails []types.PortfolioDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPortfoliosPaginator ¶ added in v0.30.0
type ListPortfoliosPaginator struct {
// contains filtered or unexported fields
}
ListPortfoliosPaginator is a paginator for ListPortfolios
func NewListPortfoliosPaginator ¶ added in v0.30.0
func NewListPortfoliosPaginator(client ListPortfoliosAPIClient, params *ListPortfoliosInput, optFns ...func(*ListPortfoliosPaginatorOptions)) *ListPortfoliosPaginator
NewListPortfoliosPaginator returns a new ListPortfoliosPaginator
func (*ListPortfoliosPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListPortfoliosPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPortfoliosPaginator) NextPage ¶ added in v0.30.0
func (p *ListPortfoliosPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPortfoliosOutput, error)
NextPage retrieves the next ListPortfolios page.
type ListPortfoliosPaginatorOptions ¶ added in v0.30.0
type ListPortfoliosPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPortfoliosPaginatorOptions is the paginator options for ListPortfolios
type ListPrincipalsForPortfolioAPIClient ¶ added in v0.30.0
type ListPrincipalsForPortfolioAPIClient interface {
ListPrincipalsForPortfolio(context.Context, *ListPrincipalsForPortfolioInput, ...func(*Options)) (*ListPrincipalsForPortfolioOutput, error)
}
ListPrincipalsForPortfolioAPIClient is a client that implements the ListPrincipalsForPortfolio operation.
type ListPrincipalsForPortfolioInput ¶
type ListPrincipalsForPortfolioInput struct { // The portfolio identifier. // // This member is required. PortfolioId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListPrincipalsForPortfolioOutput ¶
type ListPrincipalsForPortfolioOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // The PrincipalARN s and corresponding PrincipalType s associated with the // portfolio. Principals []types.Principal // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPrincipalsForPortfolioPaginator ¶ added in v0.30.0
type ListPrincipalsForPortfolioPaginator struct {
// contains filtered or unexported fields
}
ListPrincipalsForPortfolioPaginator is a paginator for ListPrincipalsForPortfolio
func NewListPrincipalsForPortfolioPaginator ¶ added in v0.30.0
func NewListPrincipalsForPortfolioPaginator(client ListPrincipalsForPortfolioAPIClient, params *ListPrincipalsForPortfolioInput, optFns ...func(*ListPrincipalsForPortfolioPaginatorOptions)) *ListPrincipalsForPortfolioPaginator
NewListPrincipalsForPortfolioPaginator returns a new ListPrincipalsForPortfolioPaginator
func (*ListPrincipalsForPortfolioPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListPrincipalsForPortfolioPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPrincipalsForPortfolioPaginator) NextPage ¶ added in v0.30.0
func (p *ListPrincipalsForPortfolioPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsForPortfolioOutput, error)
NextPage retrieves the next ListPrincipalsForPortfolio page.
type ListPrincipalsForPortfolioPaginatorOptions ¶ added in v0.30.0
type ListPrincipalsForPortfolioPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPrincipalsForPortfolioPaginatorOptions is the paginator options for ListPrincipalsForPortfolio
type ListProvisionedProductPlansInput ¶
type ListProvisionedProductPlansInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The product identifier. ProvisionProductId *string // contains filtered or unexported fields }
type ListProvisionedProductPlansOutput ¶
type ListProvisionedProductPlansOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the plans. ProvisionedProductPlans []types.ProvisionedProductPlanSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListProvisioningArtifactsForServiceActionAPIClient ¶ added in v0.30.0
type ListProvisioningArtifactsForServiceActionAPIClient interface {
ListProvisioningArtifactsForServiceAction(context.Context, *ListProvisioningArtifactsForServiceActionInput, ...func(*Options)) (*ListProvisioningArtifactsForServiceActionOutput, error)
}
ListProvisioningArtifactsForServiceActionAPIClient is a client that implements the ListProvisioningArtifactsForServiceAction operation.
type ListProvisioningArtifactsForServiceActionInput ¶
type ListProvisioningArtifactsForServiceActionInput struct { // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListProvisioningArtifactsForServiceActionOutput ¶
type ListProvisioningArtifactsForServiceActionOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // An array of objects with information about product views and provisioning // artifacts. ProvisioningArtifactViews []types.ProvisioningArtifactView // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListProvisioningArtifactsForServiceActionPaginator ¶ added in v0.30.0
type ListProvisioningArtifactsForServiceActionPaginator struct {
// contains filtered or unexported fields
}
ListProvisioningArtifactsForServiceActionPaginator is a paginator for ListProvisioningArtifactsForServiceAction
func NewListProvisioningArtifactsForServiceActionPaginator ¶ added in v0.30.0
func NewListProvisioningArtifactsForServiceActionPaginator(client ListProvisioningArtifactsForServiceActionAPIClient, params *ListProvisioningArtifactsForServiceActionInput, optFns ...func(*ListProvisioningArtifactsForServiceActionPaginatorOptions)) *ListProvisioningArtifactsForServiceActionPaginator
NewListProvisioningArtifactsForServiceActionPaginator returns a new ListProvisioningArtifactsForServiceActionPaginator
func (*ListProvisioningArtifactsForServiceActionPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListProvisioningArtifactsForServiceActionPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListProvisioningArtifactsForServiceActionPaginator) NextPage ¶ added in v0.30.0
func (p *ListProvisioningArtifactsForServiceActionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProvisioningArtifactsForServiceActionOutput, error)
NextPage retrieves the next ListProvisioningArtifactsForServiceAction page.
type ListProvisioningArtifactsForServiceActionPaginatorOptions ¶ added in v0.30.0
type ListProvisioningArtifactsForServiceActionPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListProvisioningArtifactsForServiceActionPaginatorOptions is the paginator options for ListProvisioningArtifactsForServiceAction
type ListProvisioningArtifactsOutput ¶
type ListProvisioningArtifactsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the provisioning artifacts. ProvisioningArtifactDetails []types.ProvisioningArtifactDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRecordHistoryInput ¶
type ListRecordHistoryInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The search filter to scope the results. SearchFilter *types.ListRecordHistorySearchFilter // contains filtered or unexported fields }
type ListRecordHistoryOutput ¶
type ListRecordHistoryOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // The records, in reverse chronological order. RecordDetails []types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourcesForTagOptionAPIClient ¶ added in v0.30.0
type ListResourcesForTagOptionAPIClient interface {
ListResourcesForTagOption(context.Context, *ListResourcesForTagOptionInput, ...func(*Options)) (*ListResourcesForTagOptionOutput, error)
}
ListResourcesForTagOptionAPIClient is a client that implements the ListResourcesForTagOption operation.
type ListResourcesForTagOptionInput ¶
type ListResourcesForTagOptionInput struct { // The TagOption identifier. // // This member is required. TagOptionId *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The resource type. // // - Portfolio // // - Product ResourceType *string // contains filtered or unexported fields }
type ListResourcesForTagOptionOutput ¶
type ListResourcesForTagOptionOutput struct { // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // Information about the resources. ResourceDetails []types.ResourceDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourcesForTagOptionPaginator ¶ added in v0.30.0
type ListResourcesForTagOptionPaginator struct {
// contains filtered or unexported fields
}
ListResourcesForTagOptionPaginator is a paginator for ListResourcesForTagOption
func NewListResourcesForTagOptionPaginator ¶ added in v0.30.0
func NewListResourcesForTagOptionPaginator(client ListResourcesForTagOptionAPIClient, params *ListResourcesForTagOptionInput, optFns ...func(*ListResourcesForTagOptionPaginatorOptions)) *ListResourcesForTagOptionPaginator
NewListResourcesForTagOptionPaginator returns a new ListResourcesForTagOptionPaginator
func (*ListResourcesForTagOptionPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListResourcesForTagOptionPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourcesForTagOptionPaginator) NextPage ¶ added in v0.30.0
func (p *ListResourcesForTagOptionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesForTagOptionOutput, error)
NextPage retrieves the next ListResourcesForTagOption page.
type ListResourcesForTagOptionPaginatorOptions ¶ added in v0.30.0
type ListResourcesForTagOptionPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourcesForTagOptionPaginatorOptions is the paginator options for ListResourcesForTagOption
type ListServiceActionsAPIClient ¶ added in v0.30.0
type ListServiceActionsAPIClient interface {
ListServiceActions(context.Context, *ListServiceActionsInput, ...func(*Options)) (*ListServiceActionsOutput, error)
}
ListServiceActionsAPIClient is a client that implements the ListServiceActions operation.
type ListServiceActionsForProvisioningArtifactAPIClient ¶ added in v0.30.0
type ListServiceActionsForProvisioningArtifactAPIClient interface {
ListServiceActionsForProvisioningArtifact(context.Context, *ListServiceActionsForProvisioningArtifactInput, ...func(*Options)) (*ListServiceActionsForProvisioningArtifactOutput, error)
}
ListServiceActionsForProvisioningArtifactAPIClient is a client that implements the ListServiceActionsForProvisioningArtifact operation.
type ListServiceActionsForProvisioningArtifactInput ¶
type ListServiceActionsForProvisioningArtifactInput struct { // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListServiceActionsForProvisioningArtifactOutput ¶
type ListServiceActionsForProvisioningArtifactOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // An object containing information about the self-service actions associated with // the provisioning artifact. ServiceActionSummaries []types.ServiceActionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListServiceActionsForProvisioningArtifactPaginator ¶ added in v0.30.0
type ListServiceActionsForProvisioningArtifactPaginator struct {
// contains filtered or unexported fields
}
ListServiceActionsForProvisioningArtifactPaginator is a paginator for ListServiceActionsForProvisioningArtifact
func NewListServiceActionsForProvisioningArtifactPaginator ¶ added in v0.30.0
func NewListServiceActionsForProvisioningArtifactPaginator(client ListServiceActionsForProvisioningArtifactAPIClient, params *ListServiceActionsForProvisioningArtifactInput, optFns ...func(*ListServiceActionsForProvisioningArtifactPaginatorOptions)) *ListServiceActionsForProvisioningArtifactPaginator
NewListServiceActionsForProvisioningArtifactPaginator returns a new ListServiceActionsForProvisioningArtifactPaginator
func (*ListServiceActionsForProvisioningArtifactPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListServiceActionsForProvisioningArtifactPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListServiceActionsForProvisioningArtifactPaginator) NextPage ¶ added in v0.30.0
func (p *ListServiceActionsForProvisioningArtifactPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServiceActionsForProvisioningArtifactOutput, error)
NextPage retrieves the next ListServiceActionsForProvisioningArtifact page.
type ListServiceActionsForProvisioningArtifactPaginatorOptions ¶ added in v0.30.0
type ListServiceActionsForProvisioningArtifactPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListServiceActionsForProvisioningArtifactPaginatorOptions is the paginator options for ListServiceActionsForProvisioningArtifact
type ListServiceActionsInput ¶
type ListServiceActionsInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListServiceActionsOutput ¶
type ListServiceActionsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // An object containing information about the service actions associated with the // provisioning artifact. ServiceActionSummaries []types.ServiceActionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListServiceActionsPaginator ¶ added in v0.30.0
type ListServiceActionsPaginator struct {
// contains filtered or unexported fields
}
ListServiceActionsPaginator is a paginator for ListServiceActions
func NewListServiceActionsPaginator ¶ added in v0.30.0
func NewListServiceActionsPaginator(client ListServiceActionsAPIClient, params *ListServiceActionsInput, optFns ...func(*ListServiceActionsPaginatorOptions)) *ListServiceActionsPaginator
NewListServiceActionsPaginator returns a new ListServiceActionsPaginator
func (*ListServiceActionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListServiceActionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListServiceActionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListServiceActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServiceActionsOutput, error)
NextPage retrieves the next ListServiceActions page.
type ListServiceActionsPaginatorOptions ¶ added in v0.30.0
type ListServiceActionsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListServiceActionsPaginatorOptions is the paginator options for ListServiceActions
type ListStackInstancesForProvisionedProductInput ¶
type ListStackInstancesForProvisionedProductInput struct { // The identifier of the provisioned product. // // This member is required. ProvisionedProductId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListStackInstancesForProvisionedProductOutput ¶
type ListStackInstancesForProvisionedProductOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // List of stack instances. StackInstances []types.StackInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagOptionsAPIClient ¶ added in v0.30.0
type ListTagOptionsAPIClient interface {
ListTagOptions(context.Context, *ListTagOptionsInput, ...func(*Options)) (*ListTagOptionsOutput, error)
}
ListTagOptionsAPIClient is a client that implements the ListTagOptions operation.
type ListTagOptionsInput ¶
type ListTagOptionsInput struct { // The search filters. If no search filters are specified, the output includes all // TagOptions. Filters *types.ListTagOptionsFilters // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ListTagOptionsOutput ¶
type ListTagOptionsOutput struct { // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // Information about the TagOptions. TagOptionDetails []types.TagOptionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagOptionsPaginator ¶ added in v0.30.0
type ListTagOptionsPaginator struct {
// contains filtered or unexported fields
}
ListTagOptionsPaginator is a paginator for ListTagOptions
func NewListTagOptionsPaginator ¶ added in v0.30.0
func NewListTagOptionsPaginator(client ListTagOptionsAPIClient, params *ListTagOptionsInput, optFns ...func(*ListTagOptionsPaginatorOptions)) *ListTagOptionsPaginator
NewListTagOptionsPaginator returns a new ListTagOptionsPaginator
func (*ListTagOptionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListTagOptionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTagOptionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListTagOptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagOptionsOutput, error)
NextPage retrieves the next ListTagOptions page.
type ListTagOptionsPaginatorOptions ¶ added in v0.30.0
type ListTagOptionsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTagOptionsPaginatorOptions is the paginator options for ListTagOptions
type NotifyProvisionProductEngineWorkflowResultInput ¶ added in v1.17.0
type NotifyProvisionProductEngineWorkflowResultInput struct { // The idempotency token that identifies the provisioning engine execution. // // This member is required. IdempotencyToken *string // The identifier of the record. // // This member is required. RecordId *string // The status of the provisioning engine execution. // // This member is required. Status types.EngineWorkflowStatus // The encrypted contents of the provisioning engine execution payload that // Service Catalog sends after the Terraform product provisioning workflow starts. // // This member is required. WorkflowToken *string // The reason why the provisioning engine execution failed. FailureReason *string // The output of the provisioning engine execution. Outputs []types.RecordOutput // The ID for the provisioned product resources that are part of a resource // group. ResourceIdentifier *types.EngineWorkflowResourceIdentifier // contains filtered or unexported fields }
type NotifyProvisionProductEngineWorkflowResultOutput ¶ added in v1.17.0
type NotifyProvisionProductEngineWorkflowResultOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type NotifyTerminateProvisionedProductEngineWorkflowResultInput ¶ added in v1.17.0
type NotifyTerminateProvisionedProductEngineWorkflowResultInput struct { // The idempotency token that identifies the terminate engine execution. // // This member is required. IdempotencyToken *string // The identifier of the record. // // This member is required. RecordId *string // The status of the terminate engine execution. // // This member is required. Status types.EngineWorkflowStatus // The encrypted contents of the terminate engine execution payload that Service // Catalog sends after the Terraform product terminate workflow starts. // // This member is required. WorkflowToken *string // The reason why the terminate engine execution failed. FailureReason *string // contains filtered or unexported fields }
type NotifyTerminateProvisionedProductEngineWorkflowResultOutput ¶ added in v1.17.0
type NotifyTerminateProvisionedProductEngineWorkflowResultOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type NotifyUpdateProvisionedProductEngineWorkflowResultInput ¶ added in v1.17.0
type NotifyUpdateProvisionedProductEngineWorkflowResultInput struct { // The idempotency token that identifies the update engine execution. // // This member is required. IdempotencyToken *string // The identifier of the record. // // This member is required. RecordId *string // The status of the update engine execution. // // This member is required. Status types.EngineWorkflowStatus // The encrypted contents of the update engine execution payload that Service // Catalog sends after the Terraform product update workflow starts. // // This member is required. WorkflowToken *string // The reason why the update engine execution failed. FailureReason *string // The output of the update engine execution. Outputs []types.RecordOutput // contains filtered or unexported fields }
type NotifyUpdateProvisionedProductEngineWorkflowResultOutput ¶ added in v1.17.0
type NotifyUpdateProvisionedProductEngineWorkflowResultOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.24.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type ProvisionProductInput ¶
type ProvisionProductInput struct { // An idempotency token that uniquely identifies the provisioning request. // // This member is required. ProvisionToken *string // A user-friendly name for the provisioned product. This value must be unique for // the Amazon Web Services account and cannot be updated after the product is // provisioned. // // This member is required. ProvisionedProductName *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related // events. NotificationArns []string // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the // paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both. PathId *string // The name of the path. You must provide the name or ID, but not both. PathName *string // The product identifier. You must provide the name or ID, but not both. ProductId *string // The name of the product. You must provide the name or ID, but not both. ProductName *string // The identifier of the provisioning artifact. You must provide the name or ID, // but not both. ProvisioningArtifactId *string // The name of the provisioning artifact. You must provide the name or ID, but not // both. ProvisioningArtifactName *string // Parameters specified by the administrator that are required for provisioning // the product. ProvisioningParameters []types.ProvisioningParameter // An object that contains information about the provisioning preferences for a // stack set. ProvisioningPreferences *types.ProvisioningPreferences // One or more tags. Tags []types.Tag // contains filtered or unexported fields }
type ProvisionProductOutput ¶
type ProvisionProductOutput struct { // Information about the result of provisioning the product. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RejectPortfolioShareInput ¶
type RejectPortfolioShareInput struct { // // This member is required. PortfolioId *string // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // portfolios. // // - AWS_ORGANIZATIONS - Reject portfolios shared by the management account of // your organization. // // - IMPORTED - Reject imported portfolios. // // - AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) // // For example, aws servicecatalog reject-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType // contains filtered or unexported fields }
type RejectPortfolioShareOutput ¶
type RejectPortfolioShareOutput struct { middleware.Metadata // contains filtered or unexported fields }ResultMetadata
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ScanProvisionedProductsInput ¶
type ScanProvisionedProductsInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // contains filtered or unexported fields }
type ScanProvisionedProductsOutput ¶
type ScanProvisionedProductsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the provisioned products. ProvisionedProducts []types.ProvisionedProductDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchProductsAPIClient ¶ added in v0.30.0
type SearchProductsAPIClient interface {
SearchProducts(context.Context, *SearchProductsInput, ...func(*Options)) (*SearchProductsOutput, error)
}
SearchProductsAPIClient is a client that implements the SearchProducts operation.
type SearchProductsAsAdminAPIClient ¶ added in v0.30.0
type SearchProductsAsAdminAPIClient interface {
SearchProductsAsAdmin(context.Context, *SearchProductsAsAdminInput, ...func(*Options)) (*SearchProductsAsAdminOutput, error)
}
SearchProductsAsAdminAPIClient is a client that implements the SearchProductsAsAdmin operation.
type SearchProductsAsAdminInput ¶
type SearchProductsAsAdminInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The search filters. If no search filters are specified, the output includes all // products to which the administrator has access. Filters map[string][]string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The portfolio identifier. PortfolioId *string // Access level of the source of the product. ProductSource types.ProductSource // The sort field. If no value is specified, the results are not sorted. SortBy types.ProductViewSortBy // The sort order. If no value is specified, the results are not sorted. SortOrder types.SortOrder // contains filtered or unexported fields }
type SearchProductsAsAdminOutput ¶
type SearchProductsAsAdminOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the product views. ProductViewDetails []types.ProductViewDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchProductsAsAdminPaginator ¶ added in v0.30.0
type SearchProductsAsAdminPaginator struct {
// contains filtered or unexported fields
}
SearchProductsAsAdminPaginator is a paginator for SearchProductsAsAdmin
func NewSearchProductsAsAdminPaginator ¶ added in v0.30.0
func NewSearchProductsAsAdminPaginator(client SearchProductsAsAdminAPIClient, params *SearchProductsAsAdminInput, optFns ...func(*SearchProductsAsAdminPaginatorOptions)) *SearchProductsAsAdminPaginator
NewSearchProductsAsAdminPaginator returns a new SearchProductsAsAdminPaginator
func (*SearchProductsAsAdminPaginator) HasMorePages ¶ added in v0.30.0
func (p *SearchProductsAsAdminPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchProductsAsAdminPaginator) NextPage ¶ added in v0.30.0
func (p *SearchProductsAsAdminPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchProductsAsAdminOutput, error)
NextPage retrieves the next SearchProductsAsAdmin page.
type SearchProductsAsAdminPaginatorOptions ¶ added in v0.30.0
type SearchProductsAsAdminPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
SearchProductsAsAdminPaginatorOptions is the paginator options for SearchProductsAsAdmin
type SearchProductsInput ¶
type SearchProductsInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The search filters. If no search filters are specified, the output includes all // products to which the caller has access. Filters map[string][]string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The sort field. If no value is specified, the results are not sorted. SortBy types.ProductViewSortBy // The sort order. If no value is specified, the results are not sorted. SortOrder types.SortOrder // contains filtered or unexported fields }
type SearchProductsOutput ¶
type SearchProductsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // The product view aggregations. ProductViewAggregations map[string][]types.ProductViewAggregationValue // Information about the product views. ProductViewSummaries []types.ProductViewSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchProductsPaginator ¶ added in v0.30.0
type SearchProductsPaginator struct {
// contains filtered or unexported fields
}
SearchProductsPaginator is a paginator for SearchProducts
func NewSearchProductsPaginator ¶ added in v0.30.0
func NewSearchProductsPaginator(client SearchProductsAPIClient, params *SearchProductsInput, optFns ...func(*SearchProductsPaginatorOptions)) *SearchProductsPaginator
NewSearchProductsPaginator returns a new SearchProductsPaginator
func (*SearchProductsPaginator) HasMorePages ¶ added in v0.30.0
func (p *SearchProductsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchProductsPaginator) NextPage ¶ added in v0.30.0
func (p *SearchProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchProductsOutput, error)
NextPage retrieves the next SearchProducts page.
type SearchProductsPaginatorOptions ¶ added in v0.30.0
type SearchProductsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
SearchProductsPaginatorOptions is the paginator options for SearchProducts
type SearchProvisionedProductsAPIClient ¶ added in v0.30.0
type SearchProvisionedProductsAPIClient interface {
SearchProvisionedProducts(context.Context, *SearchProvisionedProductsInput, ...func(*Options)) (*SearchProvisionedProductsOutput, error)
}
SearchProvisionedProductsAPIClient is a client that implements the SearchProvisionedProducts operation.
type SearchProvisionedProductsInput ¶
type SearchProvisionedProductsInput struct { // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The access level to use to obtain results. The default is Account . AccessLevelFilter *types.AccessLevelFilter // The search filters. // // When the key is SearchQuery , the searchable fields are arn , createdTime , id , // lastRecordId , idempotencyToken , name , physicalId , productId , // provisioningArtifactId , type , status , tags , userArn , userArnSession , // lastProvisioningRecordId , lastSuccessfulProvisioningRecordId , productName , // and provisioningArtifactName . // // Example: "SearchQuery":["status:AVAILABLE"] Filters map[string][]string // The maximum number of items to return with this call. PageSize int32 // The page token for the next set of results. To retrieve the first set of // results, use null. PageToken *string // The sort field. If no value is specified, the results are not sorted. The valid // values are arn , id , name , and lastRecordId . SortBy *string // The sort order. If no value is specified, the results are not sorted. SortOrder types.SortOrder // contains filtered or unexported fields }
type SearchProvisionedProductsOutput ¶
type SearchProvisionedProductsOutput struct { // The page token to use to retrieve the next set of results. If there are no // additional results, this value is null. NextPageToken *string // Information about the provisioned products. ProvisionedProducts []types.ProvisionedProductAttribute // The number of provisioned products found. TotalResultsCount int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchProvisionedProductsPaginator ¶ added in v0.30.0
type SearchProvisionedProductsPaginator struct {
// contains filtered or unexported fields
}
SearchProvisionedProductsPaginator is a paginator for SearchProvisionedProducts
func NewSearchProvisionedProductsPaginator ¶ added in v0.30.0
func NewSearchProvisionedProductsPaginator(client SearchProvisionedProductsAPIClient, params *SearchProvisionedProductsInput, optFns ...func(*SearchProvisionedProductsPaginatorOptions)) *SearchProvisionedProductsPaginator
NewSearchProvisionedProductsPaginator returns a new SearchProvisionedProductsPaginator
func (*SearchProvisionedProductsPaginator) HasMorePages ¶ added in v0.30.0
func (p *SearchProvisionedProductsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchProvisionedProductsPaginator) NextPage ¶ added in v0.30.0
func (p *SearchProvisionedProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchProvisionedProductsOutput, error)
NextPage retrieves the next SearchProvisionedProducts page.
type SearchProvisionedProductsPaginatorOptions ¶ added in v0.30.0
type SearchProvisionedProductsPaginatorOptions struct { // The maximum number of items to return with this call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
SearchProvisionedProductsPaginatorOptions is the paginator options for SearchProvisionedProducts
type TerminateProvisionedProductInput ¶
type TerminateProvisionedProductInput struct { // An idempotency token that uniquely identifies the termination request. This // token is only valid during the termination process. After the provisioned // product is terminated, subsequent requests to terminate the same provisioned // product always return ResourceNotFound. // // This member is required. TerminateToken *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // If set to true, Service Catalog stops managing the specified provisioned // product even if it cannot delete the underlying resources. IgnoreErrors bool // The identifier of the provisioned product. You cannot specify both // ProvisionedProductName and ProvisionedProductId . ProvisionedProductId *string // The name of the provisioned product. You cannot specify both // ProvisionedProductName and ProvisionedProductId . ProvisionedProductName *string // When this boolean parameter is set to true, the TerminateProvisionedProduct API // deletes the Service Catalog provisioned product. However, it does not remove the // CloudFormation stack, stack set, or the underlying resources of the deleted // provisioned product. The default value is false. RetainPhysicalResources bool // contains filtered or unexported fields }
type TerminateProvisionedProductOutput ¶
type TerminateProvisionedProductOutput struct { // Information about the result of this request. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateConstraintInput ¶
type UpdateConstraintInput struct { // The identifier of the constraint. // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The updated description of the constraint. Description *string // The constraint parameters, in JSON format. The syntax depends on the constraint // type as follows: // // LAUNCH You are required to specify either the RoleArn or the LocalRoleName but // can't use both. // // Specify the RoleArn property as follows: // // {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} // // Specify the LocalRoleName property as follows: // // {"LocalRoleName": "SCBasicLaunchRole"} // // If you specify the LocalRoleName property, when an account uses the launch // constraint, the IAM role with that name in the account will be used. This allows // launch-role constraints to be account-agnostic so the administrator can create // fewer resources per shared account. // // The given role name must exist in the account used to create the launch // constraint and the account of the user who launches a product with this launch // constraint. // // You cannot have both a LAUNCH and a STACKSET constraint. // // You also cannot have more than one LAUNCH constraint on a product and portfolio. // // NOTIFICATION Specify the NotificationArns property as follows: // // {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} // // RESOURCE_UPDATE Specify the TagUpdatesOnProvisionedProduct property as follows: // // {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}} // // The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED // or NOT_ALLOWED . // // STACKSET Specify the Parameters property as follows: // // {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": // [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}} // // You cannot have both a LAUNCH and a STACKSET constraint. // // You also cannot have more than one STACKSET constraint on a product and // portfolio. // // Products with a STACKSET constraint will launch an CloudFormation stack set. // // TEMPLATE Specify the Rules property. For more information, see [Template Constraint Rules]. // // [Template Constraint Rules]: http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html Parameters *string // contains filtered or unexported fields }
type UpdateConstraintOutput ¶
type UpdateConstraintOutput struct { // Information about the constraint. ConstraintDetail *types.ConstraintDetail // The constraint parameters. ConstraintParameters *string // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdatePortfolioInput ¶
type UpdatePortfolioInput struct { // The portfolio identifier. // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The tags to add. AddTags []types.Tag // The updated description of the portfolio. Description *string // The name to use for display purposes. DisplayName *string // The updated name of the portfolio provider. ProviderName *string // The tags to remove. RemoveTags []string // contains filtered or unexported fields }
type UpdatePortfolioOutput ¶
type UpdatePortfolioOutput struct { // Information about the portfolio. PortfolioDetail *types.PortfolioDetail // Information about the tags associated with the portfolio. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdatePortfolioShareInput ¶ added in v0.31.0
type UpdatePortfolioShareInput struct { // // This member is required. PortfolioId *string // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // required when updating an external account to account type share. AccountId *string OrganizationNode *types.OrganizationNode // field is not provided, the current state of the Principals sharing on the // portfolio share will not be modified. SharePrincipals *bool // is not provided, the current state of TagOptions sharing on the portfolio share // will not be modified. ShareTagOptions *bool // contains filtered or unexported fields }
type UpdatePortfolioShareOutput ¶ added in v0.31.0
type UpdatePortfolioShareOutput struct { // external account to account or organizational type sharing. PortfolioShareToken *string // status using DescribePortfolioShareStatus API. Status types.ShareStatus ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateProductInput ¶
type UpdateProductInput struct { // The product identifier. // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The tags to add to the product. AddTags []types.Tag // The updated description of the product. Description *string // The updated distributor of the product. Distributor *string // The updated product name. Name *string // The updated owner of the product. Owner *string // The tags to remove from the product. RemoveTags []string // Specifies connection details for the updated product and syncs the product to // the connection source artifact. This automatically manages the product's // artifacts based on changes to the source. The SourceConnection parameter // consists of the following sub-fields. // // - Type // // - ConnectionParamters SourceConnection *types.SourceConnection // The updated support description for the product. SupportDescription *string // The updated support email for the product. SupportEmail *string // The updated support URL for the product. SupportUrl *string // contains filtered or unexported fields }
type UpdateProductOutput ¶
type UpdateProductOutput struct { // Information about the product view. ProductViewDetail *types.ProductViewDetail // Information about the tags associated with the product. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateProvisionedProductInput ¶
type UpdateProvisionedProductInput struct { // The idempotency token that uniquely identifies the provisioning update request. // // This member is required. UpdateToken *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // The path identifier. This value is optional if the product has a default path, // and required if the product has more than one path. You must provide the name or // ID, but not both. PathId *string // The name of the path. You must provide the name or ID, but not both. PathName *string // The identifier of the product. You must provide the name or ID, but not both. ProductId *string // The name of the product. You must provide the name or ID, but not both. ProductName *string // The identifier of the provisioned product. You must provide the name or ID, but // not both. ProvisionedProductId *string // The name of the provisioned product. You cannot specify both // ProvisionedProductName and ProvisionedProductId . ProvisionedProductName *string // The identifier of the provisioning artifact. ProvisioningArtifactId *string // The name of the provisioning artifact. You must provide the name or ID, but not // both. ProvisioningArtifactName *string // The new parameters. ProvisioningParameters []types.UpdateProvisioningParameter // An object that contains information about the provisioning preferences for a // stack set. ProvisioningPreferences *types.UpdateProvisioningPreferences // One or more tags. Requires the product to have RESOURCE_UPDATE constraint with // TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. Tags []types.Tag // contains filtered or unexported fields }
type UpdateProvisionedProductOutput ¶
type UpdateProvisionedProductOutput struct { // Information about the result of the request. RecordDetail *types.RecordDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateProvisionedProductPropertiesInput ¶
type UpdateProvisionedProductPropertiesInput struct { // The idempotency token that uniquely identifies the provisioning product update // request. // // This member is required. IdempotencyToken *string // The identifier of the provisioned product. // // This member is required. ProvisionedProductId *string // A map that contains the provisioned product properties to be updated. // // The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call // UpdateProvisionedProductProperties to update the launch role that is associated // with a provisioned product. This role is used when an end user calls a // provisioning operation such as UpdateProvisionedProduct , // TerminateProvisionedProduct , or ExecuteProvisionedProductServiceAction . Only a // role ARN is valid. A user ARN is invalid. // // The OWNER key accepts user ARNs, IAM role ARNs, and STS assumed-role ARNs. The // owner is the user that has permission to see, update, terminate, and execute // service actions in the provisioned product. // // The administrator can change the owner of a provisioned product to another IAM // or STS entity within the same account. Both end user owners and administrators // can see ownership history of the provisioned product using the ListRecordHistory // API. The new owner can describe all past records for the provisioned product // using the DescribeRecord API. The previous owner can no longer use // DescribeRecord , but can still see the product's history from when he was an // owner using ListRecordHistory . // // If a provisioned product ownership is assigned to an end user, they can see and // perform any action through the API or Service Catalog console such as update, // terminate, and execute service actions. If an end user provisions a product and // the owner is updated to someone else, they will no longer be able to see or // perform any actions through API or the Service Catalog console on that // provisioned product. // // This member is required. ProvisionedProductProperties map[string]string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // contains filtered or unexported fields }
type UpdateProvisionedProductPropertiesOutput ¶
type UpdateProvisionedProductPropertiesOutput struct { // The provisioned product identifier. ProvisionedProductId *string // A map that contains the properties updated. ProvisionedProductProperties map[string]string // The identifier of the record. RecordId *string // The status of the request. Status types.RecordStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateProvisioningArtifactInput ¶
type UpdateProvisioningArtifactInput struct { // The product identifier. // // This member is required. ProductId *string // The identifier of the provisioning artifact. // // This member is required. ProvisioningArtifactId *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // Indicates whether the product version is active. // // Inactive provisioning artifacts are invisible to end users. End users cannot // launch or update a provisioned product from an inactive provisioning artifact. Active *bool // The updated description of the provisioning artifact. Description *string // Information set by the administrator to provide guidance to end users about // which provisioning artifacts to use. // // The DEFAULT value indicates that the product version is active. // // The administrator can set the guidance to DEPRECATED to inform users that the // product version is deprecated. Users are able to make updates to a provisioned // product of a deprecated version but cannot launch new provisioned products using // a deprecated version. Guidance types.ProvisioningArtifactGuidance // The updated name of the provisioning artifact. Name *string // contains filtered or unexported fields }
type UpdateProvisioningArtifactOutput ¶
type UpdateProvisioningArtifactOutput struct { // The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Info map[string]string // Information about the provisioning artifact. ProvisioningArtifactDetail *types.ProvisioningArtifactDetail // The status of the current request. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateServiceActionInput ¶
type UpdateServiceActionInput struct { // The self-service action identifier. // // This member is required. Id *string // The language code. // // - jp - Japanese // // - zh - Chinese AcceptLanguage *string // A map that defines the self-service action. Definition map[string]string // The self-service action description. Description *string // The self-service action name. Name *string // contains filtered or unexported fields }
type UpdateServiceActionOutput ¶
type UpdateServiceActionOutput struct { // Detailed information about the self-service action. ServiceActionDetail *types.ServiceActionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateTagOptionInput ¶
type UpdateTagOptionOutput ¶
type UpdateTagOptionOutput struct { // Information about the TagOption. TagOptionDetail *types.TagOptionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files
¶
- api_client.go
- api_op_AcceptPortfolioShare.go
- api_op_AssociateBudgetWithResource.go
- api_op_AssociatePrincipalWithPortfolio.go
- api_op_AssociateProductWithPortfolio.go
- api_op_AssociateServiceActionWithProvisioningArtifact.go
- api_op_AssociateTagOptionWithResource.go
- api_op_BatchAssociateServiceActionWithProvisioningArtifact.go
- api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go
- api_op_CopyProduct.go
- api_op_CreateConstraint.go
- api_op_CreatePortfolio.go
- api_op_CreatePortfolioShare.go
- api_op_CreateProduct.go
- api_op_CreateProvisionedProductPlan.go
- api_op_CreateProvisioningArtifact.go
- api_op_CreateServiceAction.go
- api_op_CreateTagOption.go
- api_op_DeleteConstraint.go
- api_op_DeletePortfolio.go
- api_op_DeletePortfolioShare.go
- api_op_DeleteProduct.go
- api_op_DeleteProvisionedProductPlan.go
- api_op_DeleteProvisioningArtifact.go
- api_op_DeleteServiceAction.go
- api_op_DeleteTagOption.go
- api_op_DescribeConstraint.go
- api_op_DescribeCopyProductStatus.go
- api_op_DescribePortfolio.go
- api_op_DescribePortfolioShareStatus.go
- api_op_DescribePortfolioShares.go
- api_op_DescribeProduct.go
- api_op_DescribeProductAsAdmin.go
- api_op_DescribeProductView.go
- api_op_DescribeProvisionedProduct.go
- api_op_DescribeProvisionedProductPlan.go
- api_op_DescribeProvisioningArtifact.go
- api_op_DescribeProvisioningParameters.go
- api_op_DescribeRecord.go
- api_op_DescribeServiceAction.go
- api_op_DescribeServiceActionExecutionParameters.go
- api_op_DescribeTagOption.go
- api_op_DisableAWSOrganizationsAccess.go
- api_op_DisassociateBudgetFromResource.go
- api_op_DisassociatePrincipalFromPortfolio.go
- api_op_DisassociateProductFromPortfolio.go
- api_op_DisassociateServiceActionFromProvisioningArtifact.go
- api_op_DisassociateTagOptionFromResource.go
- api_op_EnableAWSOrganizationsAccess.go
- api_op_ExecuteProvisionedProductPlan.go
- api_op_ExecuteProvisionedProductServiceAction.go
- api_op_GetAWSOrganizationsAccessStatus.go
- api_op_GetProvisionedProductOutputs.go
- api_op_ImportAsProvisionedProduct.go
- api_op_ListAcceptedPortfolioShares.go
- api_op_ListBudgetsForResource.go
- api_op_ListConstraintsForPortfolio.go
- api_op_ListLaunchPaths.go
- api_op_ListOrganizationPortfolioAccess.go
- api_op_ListPortfolioAccess.go
- api_op_ListPortfolios.go
- api_op_ListPortfoliosForProduct.go
- api_op_ListPrincipalsForPortfolio.go
- api_op_ListProvisionedProductPlans.go
- api_op_ListProvisioningArtifacts.go
- api_op_ListProvisioningArtifactsForServiceAction.go
- api_op_ListRecordHistory.go
- api_op_ListResourcesForTagOption.go
- api_op_ListServiceActions.go
- api_op_ListServiceActionsForProvisioningArtifact.go
- api_op_ListStackInstancesForProvisionedProduct.go
- api_op_ListTagOptions.go
- api_op_NotifyProvisionProductEngineWorkflowResult.go
- api_op_NotifyTerminateProvisionedProductEngineWorkflowResult.go
- api_op_NotifyUpdateProvisionedProductEngineWorkflowResult.go
- api_op_ProvisionProduct.go
- api_op_RejectPortfolioShare.go
- api_op_ScanProvisionedProducts.go
- api_op_SearchProducts.go
- api_op_SearchProductsAsAdmin.go
- api_op_SearchProvisionedProducts.go
- api_op_TerminateProvisionedProduct.go
- api_op_UpdateConstraint.go
- api_op_UpdatePortfolio.go
- api_op_UpdatePortfolioShare.go
- api_op_UpdateProduct.go
- api_op_UpdateProvisionedProduct.go
- api_op_UpdateProvisionedProductProperties.go
- api_op_UpdateProvisioningArtifact.go
- api_op_UpdateServiceAction.go
- api_op_UpdateTagOption.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go