Struct aws_sdk_servicecatalog::client::Client

pub struct Client { /* private fields */ }

Client for AWS Service Catalog

Client for invoking operations on AWS Service Catalog. Each operation on AWS Service Catalog is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_servicecatalog::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_servicecatalog::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptPortfolioShare operation has a Client::accept_portfolio_share, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_portfolio_share()
    .accept_language("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_portfolio_share(&self) -> AcceptPortfolioShareFluentBuilder

Constructs a fluent builder for the AcceptPortfolioShare operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • portfolio_share_type(PortfolioShareType) / set_portfolio_share_type(Option<PortfolioShareType>):
    required: false
    

    The type of shared portfolios to accept. The default is to accept imported 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

    
    
• On success, responds with AcceptPortfolioShareOutput
• On failure, responds with SdkError<AcceptPortfolioShareError>

impl Client

pub fn associate_budget_with_resource( &self ) -> AssociateBudgetWithResourceFluentBuilder

Constructs a fluent builder for the AssociateBudgetWithResource operation.

• The fluent builder is configurable:
  • budget_name(impl Into<String>) / set_budget_name(Option<String>):
    required: true
    

    The name of the budget you want to associate.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource identifier. Either a portfolio-id or a product-id.

    
    
• On success, responds with AssociateBudgetWithResourceOutput
• On failure, responds with SdkError<AssociateBudgetWithResourceError>

impl Client

pub fn associate_principal_with_portfolio( &self ) -> AssociatePrincipalWithPortfolioFluentBuilder

Constructs a fluent builder for the AssociatePrincipalWithPortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • principal_arn(impl Into<String>) / set_principal_arn(Option<String>):
    required: true
    

    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_PATTERNs 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.

    
    
  • principal_type(PrincipalType) / set_principal_type(Option<PrincipalType>):
    required: true
    

    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.

    
    
• On success, responds with AssociatePrincipalWithPortfolioOutput
• On failure, responds with SdkError<AssociatePrincipalWithPortfolioError>

impl Client

pub fn associate_product_with_portfolio( &self ) -> AssociateProductWithPortfolioFluentBuilder

Constructs a fluent builder for the AssociateProductWithPortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • source_portfolio_id(impl Into<String>) / set_source_portfolio_id(Option<String>):
    required: false
    

    The identifier of the source portfolio.

    
    
• On success, responds with AssociateProductWithPortfolioOutput
• On failure, responds with SdkError<AssociateProductWithPortfolioError>

impl Client

pub fn associate_service_action_with_provisioning_artifact( &self ) -> AssociateServiceActionWithProvisioningArtifactFluentBuilder

Constructs a fluent builder for the AssociateServiceActionWithProvisioningArtifact operation.

• The fluent builder is configurable:
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier. For example, prod-abcdzk7xy33qa.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    
    
  • service_action_id(impl Into<String>) / set_service_action_id(Option<String>):
    required: true
    

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with AssociateServiceActionWithProvisioningArtifactOutput
• On failure, responds with SdkError<AssociateServiceActionWithProvisioningArtifactError>

impl Client

pub fn associate_tag_option_with_resource( &self ) -> AssociateTagOptionWithResourceFluentBuilder

Constructs a fluent builder for the AssociateTagOptionWithResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource identifier.

    
    
  • tag_option_id(impl Into<String>) / set_tag_option_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
• On success, responds with AssociateTagOptionWithResourceOutput
• On failure, responds with SdkError<AssociateTagOptionWithResourceError>

impl Client

pub fn batch_associate_service_action_with_provisioning_artifact( &self ) -> BatchAssociateServiceActionWithProvisioningArtifactFluentBuilder

Constructs a fluent builder for the BatchAssociateServiceActionWithProvisioningArtifact operation.

• The fluent builder is configurable:
  • service_action_associations(ServiceActionAssociation) / set_service_action_associations(Option<Vec::<ServiceActionAssociation>>):
    required: true
    

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with BatchAssociateServiceActionWithProvisioningArtifactOutput with field(s):
  • failed_service_action_associations(Option<Vec::<FailedServiceActionAssociation>>):

    An object that contains a list of errors, along with information to help you identify the self-service action.

• On failure, responds with SdkError<BatchAssociateServiceActionWithProvisioningArtifactError>

impl Client

pub fn batch_disassociate_service_action_from_provisioning_artifact( &self ) -> BatchDisassociateServiceActionFromProvisioningArtifactFluentBuilder

Constructs a fluent builder for the BatchDisassociateServiceActionFromProvisioningArtifact operation.

• The fluent builder is configurable:
  • service_action_associations(ServiceActionAssociation) / set_service_action_associations(Option<Vec::<ServiceActionAssociation>>):
    required: true
    

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with BatchDisassociateServiceActionFromProvisioningArtifactOutput with field(s):
  • failed_service_action_associations(Option<Vec::<FailedServiceActionAssociation>>):

    An object that contains a list of errors, along with information to help you identify the self-service action.

• On failure, responds with SdkError<BatchDisassociateServiceActionFromProvisioningArtifactError>

impl Client

pub fn copy_product(&self) -> CopyProductFluentBuilder

Constructs a fluent builder for the CopyProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • source_product_arn(impl Into<String>) / set_source_product_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the source product.

    
    
  • target_product_id(impl Into<String>) / set_target_product_id(Option<String>):
    required: false
    

    The identifier of the target product. By default, a new product is created.

    
    
  • target_product_name(impl Into<String>) / set_target_product_name(Option<String>):
    required: false
    

    A name for the target product. The default is the name of the source product.

    
    
  • source_provisioning_artifact_identifiers(HashMap::<ProvisioningArtifactPropertyName, String>) / set_source_provisioning_artifact_identifiers(Option<Vec::<HashMap::<ProvisioningArtifactPropertyName, String>>>):
    required: false
    

    The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

    
    
  • copy_options(CopyOption) / set_copy_options(Option<Vec::<CopyOption>>):
    required: false
    

    The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CopyProductOutput with field(s):
  • copy_product_token(Option<String>):

    The token to use to track the progress of the operation.

• On failure, responds with SdkError<CopyProductError>

impl Client

pub fn create_constraint(&self) -> CreateConstraintFluentBuilder

Constructs a fluent builder for the CreateConstraint operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • parameters(impl Into<String>) / set_parameters(Option<String>):
    required: true
    

    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.

    
    
  • r#type(impl Into<String>) / set_type(Option<String>):
    required: true
    

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • RESOURCE_UPDATE

    • STACKSET

    • TEMPLATE

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the constraint.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateConstraintOutput with field(s):
  • constraint_detail(Option<ConstraintDetail>):

    Information about the constraint.

  • constraint_parameters(Option<String>):

    The constraint parameters.

  • status(Option<Status>):

    The status of the current request.

• On failure, responds with SdkError<CreateConstraintError>

impl Client

pub fn create_portfolio(&self) -> CreatePortfolioFluentBuilder

Constructs a fluent builder for the CreatePortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The name to use for display purposes.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the portfolio.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: true
    

    The name of the portfolio provider.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreatePortfolioOutput with field(s):
  • portfolio_detail(Option<PortfolioDetail>):

    Information about the portfolio.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the portfolio.

• On failure, responds with SdkError<CreatePortfolioError>

impl Client

pub fn create_portfolio_share(&self) -> CreatePortfolioShareFluentBuilder

Constructs a fluent builder for the CreatePortfolioShare operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    The Amazon Web Services account ID. For example, 123456789012.

    
    
  • organization_node(OrganizationNode) / set_organization_node(Option<OrganizationNode>):
    required: false
    

    The organization node to whom you are going to share. When you pass 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.

    
    
  • share_tag_options(bool) / set_share_tag_options(Option<bool>):
    required: false
    

    Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

    
    
  • share_principals(bool) / set_share_principals(Option<bool>):
    required: false
    

    This parameter is only supported for portfolios with an OrganizationalNode Type 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.

    
    
• On success, responds with CreatePortfolioShareOutput with field(s):
  • portfolio_share_token(Option<String>):

    The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

• On failure, responds with SdkError<CreatePortfolioShareError>

impl Client

pub fn create_product(&self) -> CreateProductFluentBuilder

Constructs a fluent builder for the CreateProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the product.

    
    
  • owner(impl Into<String>) / set_owner(Option<String>):
    required: true
    

    The owner of the product.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the product.

    
    
  • distributor(impl Into<String>) / set_distributor(Option<String>):
    required: false
    

    The distributor of the product.

    
    
  • support_description(impl Into<String>) / set_support_description(Option<String>):
    required: false
    

    The support information about the product.

    
    
  • support_email(impl Into<String>) / set_support_email(Option<String>):
    required: false
    

    The contact email for product support.

    
    
  • support_url(impl Into<String>) / set_support_url(Option<String>):
    required: false
    

    The contact URL for product support.

    ^https?:/// / is the pattern used to validate SupportUrl.

    
    
  • product_type(ProductType) / set_product_type(Option<ProductType>):
    required: true
    

    The type of product.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags.

    
    
  • provisioning_artifact_parameters(ProvisioningArtifactProperties) / set_provisioning_artifact_parameters(Option<ProvisioningArtifactProperties>):
    required: false
    

    The configuration of the provisioning artifact.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
  • source_connection(SourceConnection) / set_source_connection(Option<SourceConnection>):
    required: false
    

    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

    
    
• On success, responds with CreateProductOutput with field(s):
  • product_view_detail(Option<ProductViewDetail>):

    Information about the product view.

  • provisioning_artifact_detail(Option<ProvisioningArtifactDetail>):

    Information about the provisioning artifact.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the product.

• On failure, responds with SdkError<CreateProductError>

impl Client

pub fn create_provisioned_product_plan( &self ) -> CreateProvisionedProductPlanFluentBuilder

Constructs a fluent builder for the CreateProvisionedProductPlan operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • plan_name(impl Into<String>) / set_plan_name(Option<String>):
    required: true
    

    The name of the plan.

    
    
  • plan_type(ProvisionedProductPlanType) / set_plan_type(Option<ProvisionedProductPlanType>):
    required: true
    

    The plan type.

    
    
  • notification_arns(impl Into<String>) / set_notification_arns(Option<Vec::<String>>):
    required: false
    

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    
    
  • path_id(impl Into<String>) / set_path_id(Option<String>):
    required: false
    

    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.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: true
    

    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.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact.

    
    
  • provisioning_parameters(UpdateProvisioningParameter) / set_provisioning_parameters(Option<Vec::<UpdateProvisioningParameter>>):
    required: false
    

    Parameters specified by the administrator that are required for provisioning the product.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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.

    
    
• On success, responds with CreateProvisionedProductPlanOutput with field(s):
  • plan_name(Option<String>):

    The name of the plan.

  • plan_id(Option<String>):

    The plan identifier.

  • provision_product_id(Option<String>):

    The product identifier.

  • provisioned_product_name(Option<String>):

    The user-friendly name of the provisioned product.

  • provisioning_artifact_id(Option<String>):

    The identifier of the provisioning artifact.

• On failure, responds with SdkError<CreateProvisionedProductPlanError>

impl Client

pub fn create_provisioning_artifact( &self ) -> CreateProvisioningArtifactFluentBuilder

Constructs a fluent builder for the CreateProvisioningArtifact operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • parameters(ProvisioningArtifactProperties) / set_parameters(Option<ProvisioningArtifactProperties>):
    required: true
    

    The configuration for the provisioning artifact.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateProvisioningArtifactOutput with field(s):
  • provisioning_artifact_detail(Option<ProvisioningArtifactDetail>):

    Information about the provisioning artifact.

  • info(Option<HashMap::<String, String>>):

    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.

  • status(Option<Status>):

    The status of the current request.

• On failure, responds with SdkError<CreateProvisioningArtifactError>

impl Client

pub fn create_service_action(&self) -> CreateServiceActionFluentBuilder

Constructs a fluent builder for the CreateServiceAction operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The self-service action name.

    
    
  • definition_type(ServiceActionDefinitionType) / set_definition_type(Option<ServiceActionDefinitionType>):
    required: true
    

    The service action definition type. For example, SSM_AUTOMATION.

    
    
  • definition(ServiceActionDefinitionKey, impl Into<String>) / set_definition(Option<HashMap::<ServiceActionDefinitionKey, String>>):
    required: true
    

    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"}].

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The self-service action description.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateServiceActionOutput with field(s):
  • service_action_detail(Option<ServiceActionDetail>):

    An object containing information about the self-service action.

• On failure, responds with SdkError<CreateServiceActionError>

impl Client

pub fn create_tag_option(&self) -> CreateTagOptionFluentBuilder

Constructs a fluent builder for the CreateTagOption operation.

• The fluent builder is configurable:
  • key(impl Into<String>) / set_key(Option<String>):
    required: true
    

    The TagOption key.

    
    
  • value(impl Into<String>) / set_value(Option<String>):
    required: true
    

    The TagOption value.

    
    
• On success, responds with CreateTagOptionOutput with field(s):
  • tag_option_detail(Option<TagOptionDetail>):

    Information about the TagOption.

• On failure, responds with SdkError<CreateTagOptionError>

impl Client

pub fn delete_constraint(&self) -> DeleteConstraintFluentBuilder

Constructs a fluent builder for the DeleteConstraint operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the constraint.

    
    
• On success, responds with DeleteConstraintOutput
• On failure, responds with SdkError<DeleteConstraintError>

impl Client

pub fn delete_portfolio(&self) -> DeletePortfolioFluentBuilder

Constructs a fluent builder for the DeletePortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
• On success, responds with DeletePortfolioOutput
• On failure, responds with SdkError<DeletePortfolioError>

impl Client

pub fn delete_portfolio_share(&self) -> DeletePortfolioShareFluentBuilder

Constructs a fluent builder for the DeletePortfolioShare operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    The Amazon Web Services account ID.

    
    
  • organization_node(OrganizationNode) / set_organization_node(Option<OrganizationNode>):
    required: false
    

    The organization node to whom you are going to stop sharing.

    
    
• On success, responds with DeletePortfolioShareOutput with field(s):
  • portfolio_share_token(Option<String>):

    The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

• On failure, responds with SdkError<DeletePortfolioShareError>

impl Client

pub fn delete_product(&self) -> DeleteProductFluentBuilder

Constructs a fluent builder for the DeleteProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The product identifier.

    
    
• On success, responds with DeleteProductOutput
• On failure, responds with SdkError<DeleteProductError>

impl Client

pub fn delete_provisioned_product_plan( &self ) -> DeleteProvisionedProductPlanFluentBuilder

Constructs a fluent builder for the DeleteProvisionedProductPlan operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • plan_id(impl Into<String>) / set_plan_id(Option<String>):
    required: true
    

    The plan identifier.

    
    
  • ignore_errors(bool) / set_ignore_errors(Option<bool>):
    required: false
    

    If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

    
    
• On success, responds with DeleteProvisionedProductPlanOutput
• On failure, responds with SdkError<DeleteProvisionedProductPlanError>

impl Client

pub fn delete_provisioning_artifact( &self ) -> DeleteProvisioningArtifactFluentBuilder

Constructs a fluent builder for the DeleteProvisioningArtifact operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact.

    
    
• On success, responds with DeleteProvisioningArtifactOutput
• On failure, responds with SdkError<DeleteProvisioningArtifactError>

impl Client

pub fn delete_service_action(&self) -> DeleteServiceActionFluentBuilder

Constructs a fluent builder for the DeleteServiceAction operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteServiceActionOutput
• On failure, responds with SdkError<DeleteServiceActionError>

impl Client

pub fn delete_tag_option(&self) -> DeleteTagOptionFluentBuilder

Constructs a fluent builder for the DeleteTagOption operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
• On success, responds with DeleteTagOptionOutput
• On failure, responds with SdkError<DeleteTagOptionError>

impl Client

pub fn describe_constraint(&self) -> DescribeConstraintFluentBuilder

Constructs a fluent builder for the DescribeConstraint operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the constraint.

    
    
• On success, responds with DescribeConstraintOutput with field(s):
  • constraint_detail(Option<ConstraintDetail>):

    Information about the constraint.

  • constraint_parameters(Option<String>):

    The constraint parameters.

  • status(Option<Status>):

    The status of the current request.

• On failure, responds with SdkError<DescribeConstraintError>

impl Client

pub fn describe_copy_product_status( &self ) -> DescribeCopyProductStatusFluentBuilder

Constructs a fluent builder for the DescribeCopyProductStatus operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • copy_product_token(impl Into<String>) / set_copy_product_token(Option<String>):
    required: true
    

    The token for the copy product operation. This token is returned by CopyProduct.

    
    
• On success, responds with DescribeCopyProductStatusOutput with field(s):
  • copy_product_status(Option<CopyProductStatus>):

    The status of the copy product operation.

  • target_product_id(Option<String>):

    The identifier of the copied product.

  • status_detail(Option<String>):

    The status message.

• On failure, responds with SdkError<DescribeCopyProductStatusError>

impl Client

pub fn describe_portfolio(&self) -> DescribePortfolioFluentBuilder

Constructs a fluent builder for the DescribePortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
• On success, responds with DescribePortfolioOutput with field(s):
  • portfolio_detail(Option<PortfolioDetail>):

    Information about the portfolio.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the portfolio.

  • tag_options(Option<Vec::<TagOptionDetail>>):

    Information about the TagOptions associated with the portfolio.

  • budgets(Option<Vec::<BudgetDetail>>):

    Information about the associated budgets.

• On failure, responds with SdkError<DescribePortfolioError>

impl Client

pub fn describe_portfolio_share_status( &self ) -> DescribePortfolioShareStatusFluentBuilder

Constructs a fluent builder for the DescribePortfolioShareStatus operation.

• The fluent builder is configurable:
  • portfolio_share_token(impl Into<String>) / set_portfolio_share_token(Option<String>):
    required: true
    

    The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

    
    
• On success, responds with DescribePortfolioShareStatusOutput with field(s):
  • portfolio_share_token(Option<String>):

    The token for the portfolio share operation. For example, share-6v24abcdefghi.

  • portfolio_id(Option<String>):

    The portfolio identifier.

  • organization_node_value(Option<String>):

    Organization node identifier. It can be either account id, organizational unit id or organization id.

  • status(Option<ShareStatus>):

    Status of the portfolio share operation.

  • share_details(Option<ShareDetails>):

    Information about the portfolio share operation.

• On failure, responds with SdkError<DescribePortfolioShareStatusError>

impl Client

pub fn describe_portfolio_shares(&self) -> DescribePortfolioSharesFluentBuilder

Constructs a fluent builder for the DescribePortfolioShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The unique identifier of the portfolio for which shares will be retrieved.

    
    
  • r#type(DescribePortfolioShareType) / set_type(Option<DescribePortfolioShareType>):
    required: true
    

    The type of portfolio share to summarize. This field acts as a filter on the 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.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with DescribePortfolioSharesOutput with field(s):
  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

  • portfolio_share_details(Option<Vec::<PortfolioShareDetail>>):

    Summaries about each of the portfolio shares.

• On failure, responds with SdkError<DescribePortfolioSharesError>

impl Client

pub fn describe_product(&self) -> DescribeProductFluentBuilder

Constructs a fluent builder for the DescribeProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    The product identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The product name.

    
    
• On success, responds with DescribeProductOutput with field(s):
  • product_view_summary(Option<ProductViewSummary>):

    Summary information about the product view.

  • provisioning_artifacts(Option<Vec::<ProvisioningArtifact>>):

    Information about the provisioning artifacts for the specified product.

  • budgets(Option<Vec::<BudgetDetail>>):

    Information about the associated budgets.

  • launch_paths(Option<Vec::<LaunchPath>>):

    Information about the associated launch paths.

• On failure, responds with SdkError<DescribeProductError>

impl Client

pub fn describe_product_as_admin(&self) -> DescribeProductAsAdminFluentBuilder

Constructs a fluent builder for the DescribeProductAsAdmin operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    The product identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The product name.

    
    
  • source_portfolio_id(impl Into<String>) / set_source_portfolio_id(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DescribeProductAsAdminOutput with field(s):
  • product_view_detail(Option<ProductViewDetail>):

    Information about the product view.

  • provisioning_artifact_summaries(Option<Vec::<ProvisioningArtifactSummary>>):

    Information about the provisioning artifacts (also known as versions) for the specified product.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the product.

  • tag_options(Option<Vec::<TagOptionDetail>>):

    Information about the TagOptions associated with the product.

  • budgets(Option<Vec::<BudgetDetail>>):

    Information about the associated budgets.

• On failure, responds with SdkError<DescribeProductAsAdminError>

impl Client

pub fn describe_product_view(&self) -> DescribeProductViewFluentBuilder

Constructs a fluent builder for the DescribeProductView operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The product view identifier.

    
    
• On success, responds with DescribeProductViewOutput with field(s):
  • product_view_summary(Option<ProductViewSummary>):

    Summary information about the product.

  • provisioning_artifacts(Option<Vec::<ProvisioningArtifact>>):

    Information about the provisioning artifacts for the product.

• On failure, responds with SdkError<DescribeProductViewError>

impl Client

pub fn describe_provisioned_product( &self ) -> DescribeProvisionedProductFluentBuilder

Constructs a fluent builder for the DescribeProvisionedProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DescribeProvisionedProductOutput with field(s):
  • provisioned_product_detail(Option<ProvisionedProductDetail>):

    Information about the provisioned product.

  • cloud_watch_dashboards(Option<Vec::<CloudWatchDashboard>>):

    Any CloudWatch dashboards that were created when provisioning the product.

• On failure, responds with SdkError<DescribeProvisionedProductError>

impl Client

pub fn describe_provisioned_product_plan( &self ) -> DescribeProvisionedProductPlanFluentBuilder

Constructs a fluent builder for the DescribeProvisionedProductPlan operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • plan_id(impl Into<String>) / set_plan_id(Option<String>):
    required: true
    

    The plan identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with DescribeProvisionedProductPlanOutput with field(s):
  • provisioned_product_plan_details(Option<ProvisionedProductPlanDetails>):

    Information about the plan.

  • resource_changes(Option<Vec::<ResourceChange>>):

    Information about the resource changes that will occur when the plan is executed.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<DescribeProvisionedProductPlanError>

impl Client

pub fn describe_provisioning_artifact( &self ) -> DescribeProvisioningArtifactFluentBuilder

Constructs a fluent builder for the DescribeProvisioningArtifact operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: false
    

    The identifier of the provisioning artifact.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: false
    

    The product identifier.

    
    
  • provisioning_artifact_name(impl Into<String>) / set_provisioning_artifact_name(Option<String>):
    required: false
    

    The provisioning artifact name.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: false
    

    The product name.

    
    
  • verbose(bool) / set_verbose(Option<bool>):
    required: false
    

    Indicates whether a verbose level of detail is enabled.

    
    
  • include_provisioning_artifact_parameters(bool) / set_include_provisioning_artifact_parameters(Option<bool>):
    required: false
    

    Indicates if the API call response does or does not include additional details about the provisioning parameters.

    
    
• On success, responds with DescribeProvisioningArtifactOutput with field(s):
  • provisioning_artifact_detail(Option<ProvisioningArtifactDetail>):

    Information about the provisioning artifact.

  • info(Option<HashMap::<String, String>>):

    The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

  • status(Option<Status>):

    The status of the current request.

  • provisioning_artifact_parameters(Option<Vec::<ProvisioningArtifactParameter>>):

    Information about the parameters used to provision the product.

• On failure, responds with SdkError<DescribeProvisioningArtifactError>

impl Client

pub fn describe_provisioning_parameters( &self ) -> DescribeProvisioningParametersFluentBuilder

Constructs a fluent builder for the DescribeProvisioningParameters operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: false
    

    The product identifier. You must provide the product name or ID, but not both.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: false
    

    The name of the product. You must provide the name or ID, but not both.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: false
    

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    
    
  • provisioning_artifact_name(impl Into<String>) / set_provisioning_artifact_name(Option<String>):
    required: false
    

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    
    
  • path_id(impl Into<String>) / set_path_id(Option<String>):
    required: false
    

    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.

    
    
  • path_name(impl Into<String>) / set_path_name(Option<String>):
    required: false
    

    The name of the path. You must provide the name or ID, but not both.

    
    
• On success, responds with DescribeProvisioningParametersOutput with field(s):
  • provisioning_artifact_parameters(Option<Vec::<ProvisioningArtifactParameter>>):

    Information about the parameters used to provision the product.

  • constraint_summaries(Option<Vec::<ConstraintSummary>>):

    Information about the constraints used to provision the product.

  • usage_instructions(Option<Vec::<UsageInstruction>>):

    Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

  • tag_options(Option<Vec::<TagOptionSummary>>):

    Information about the TagOptions associated with the resource.

  • provisioning_artifact_preferences(Option<ProvisioningArtifactPreferences>):

    An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

  • provisioning_artifact_outputs(Option<Vec::<ProvisioningArtifactOutput>>):

    The output of the provisioning artifact.

  • provisioning_artifact_output_keys(Option<Vec::<ProvisioningArtifactOutput>>):

    A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

• On failure, responds with SdkError<DescribeProvisioningParametersError>

impl Client

pub fn describe_record(&self) -> DescribeRecordFluentBuilder

Constructs a fluent builder for the DescribeRecord operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The record identifier of the provisioned product. This identifier is returned by the request operation.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with DescribeRecordOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about the product.

  • record_outputs(Option<Vec::<RecordOutput>>):

    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.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<DescribeRecordError>

impl Client

pub fn describe_service_action(&self) -> DescribeServiceActionFluentBuilder

Constructs a fluent builder for the DescribeServiceAction operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The self-service action identifier.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with DescribeServiceActionOutput with field(s):
  • service_action_detail(Option<ServiceActionDetail>):

    Detailed information about the self-service action.

• On failure, responds with SdkError<DescribeServiceActionError>

impl Client

pub fn describe_service_action_execution_parameters( &self ) -> DescribeServiceActionExecutionParametersFluentBuilder

Constructs a fluent builder for the DescribeServiceActionExecutionParameters operation.

• The fluent builder is configurable:
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: true
    

    The identifier of the provisioned product.

    
    
  • service_action_id(impl Into<String>) / set_service_action_id(Option<String>):
    required: true
    

    The self-service action identifier.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with DescribeServiceActionExecutionParametersOutput with field(s):
  • service_action_parameters(Option<Vec::<ExecutionParameter>>):

    The parameters of the self-service action.

• On failure, responds with SdkError<DescribeServiceActionExecutionParametersError>

impl Client

pub fn describe_tag_option(&self) -> DescribeTagOptionFluentBuilder

Constructs a fluent builder for the DescribeTagOption operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
• On success, responds with DescribeTagOptionOutput with field(s):
  • tag_option_detail(Option<TagOptionDetail>):

    Information about the TagOption.

• On failure, responds with SdkError<DescribeTagOptionError>

impl Client

pub fn disable_aws_organizations_access( &self ) -> DisableAWSOrganizationsAccessFluentBuilder

Constructs a fluent builder for the DisableAWSOrganizationsAccess operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisableAwsOrganizationsAccessOutput
• On failure, responds with SdkError<DisableAWSOrganizationsAccessError>

impl Client

pub fn disassociate_budget_from_resource( &self ) -> DisassociateBudgetFromResourceFluentBuilder

Constructs a fluent builder for the DisassociateBudgetFromResource operation.

• The fluent builder is configurable:
  • budget_name(impl Into<String>) / set_budget_name(Option<String>):
    required: true
    

    The name of the budget you want to disassociate.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

    
    
• On success, responds with DisassociateBudgetFromResourceOutput
• On failure, responds with SdkError<DisassociateBudgetFromResourceError>

impl Client

pub fn disassociate_principal_from_portfolio( &self ) -> DisassociatePrincipalFromPortfolioFluentBuilder

Constructs a fluent builder for the DisassociatePrincipalFromPortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • principal_arn(impl Into<String>) / set_principal_arn(Option<String>):
    required: true
    

    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.

    
    
  • principal_type(PrincipalType) / set_principal_type(Option<PrincipalType>):
    required: false
    

    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.

    
    
• On success, responds with DisassociatePrincipalFromPortfolioOutput
• On failure, responds with SdkError<DisassociatePrincipalFromPortfolioError>

impl Client

pub fn disassociate_product_from_portfolio( &self ) -> DisassociateProductFromPortfolioFluentBuilder

Constructs a fluent builder for the DisassociateProductFromPortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
• On success, responds with DisassociateProductFromPortfolioOutput
• On failure, responds with SdkError<DisassociateProductFromPortfolioError>

impl Client

pub fn disassociate_service_action_from_provisioning_artifact( &self ) -> DisassociateServiceActionFromProvisioningArtifactFluentBuilder

Constructs a fluent builder for the DisassociateServiceActionFromProvisioningArtifact operation.

• The fluent builder is configurable:
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier. For example, prod-abcdzk7xy33qa.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    
    
  • service_action_id(impl Into<String>) / set_service_action_id(Option<String>):
    required: true
    

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DisassociateServiceActionFromProvisioningArtifactOutput
• On failure, responds with SdkError<DisassociateServiceActionFromProvisioningArtifactError>

impl Client

pub fn disassociate_tag_option_from_resource( &self ) -> DisassociateTagOptionFromResourceFluentBuilder

Constructs a fluent builder for the DisassociateTagOptionFromResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource identifier.

    
    
  • tag_option_id(impl Into<String>) / set_tag_option_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
• On success, responds with DisassociateTagOptionFromResourceOutput
• On failure, responds with SdkError<DisassociateTagOptionFromResourceError>

impl Client

pub fn enable_aws_organizations_access( &self ) -> EnableAWSOrganizationsAccessFluentBuilder

Constructs a fluent builder for the EnableAWSOrganizationsAccess operation.

• The fluent builder takes no input, just send it.
• On success, responds with EnableAwsOrganizationsAccessOutput
• On failure, responds with SdkError<EnableAWSOrganizationsAccessError>

impl Client

pub fn execute_provisioned_product_plan( &self ) -> ExecuteProvisionedProductPlanFluentBuilder

Constructs a fluent builder for the ExecuteProvisionedProductPlan operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • plan_id(impl Into<String>) / set_plan_id(Option<String>):
    required: true
    

    The plan identifier.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with ExecuteProvisionedProductPlanOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about the result of provisioning the product.

• On failure, responds with SdkError<ExecuteProvisionedProductPlanError>

impl Client

pub fn execute_provisioned_product_service_action( &self ) -> ExecuteProvisionedProductServiceActionFluentBuilder

Constructs a fluent builder for the ExecuteProvisionedProductServiceAction operation.

• The fluent builder is configurable:
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: true
    

    The identifier of the provisioned product.

    
    
  • service_action_id(impl Into<String>) / set_service_action_id(Option<String>):
    required: true
    

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    
    
  • execute_token(impl Into<String>) / set_execute_token(Option<String>):
    required: true
    

    An idempotency token that uniquely identifies the execute request.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    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.

    
    
• On success, responds with ExecuteProvisionedProductServiceActionOutput with field(s):
  • record_detail(Option<RecordDetail>):

    An object containing detailed information about the result of provisioning the product.

• On failure, responds with SdkError<ExecuteProvisionedProductServiceActionError>

impl Client

pub fn get_aws_organizations_access_status( &self ) -> GetAWSOrganizationsAccessStatusFluentBuilder

Constructs a fluent builder for the GetAWSOrganizationsAccessStatus operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAwsOrganizationsAccessStatusOutput with field(s):
  • access_status(Option<AccessStatus>):

    The status of the portfolio share feature.

• On failure, responds with SdkError<GetAWSOrganizationsAccessStatusError>

impl Client

pub fn get_provisioned_product_outputs( &self ) -> GetProvisionedProductOutputsFluentBuilder

Constructs a fluent builder for the GetProvisionedProductOutputs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: false
    

    The identifier of the provisioned product that you want the outputs from.

    
    
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: false
    

    The name of the provisioned product that you want the outputs from.

    
    
  • output_keys(impl Into<String>) / set_output_keys(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with GetProvisionedProductOutputsOutput with field(s):
  • outputs(Option<Vec::<RecordOutput>>):

    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.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<GetProvisionedProductOutputsError>

impl Client

pub fn import_as_provisioned_product( &self ) -> ImportAsProvisionedProductFluentBuilder

Constructs a fluent builder for the ImportAsProvisionedProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact.

    
    
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: true
    

    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.

    
    
  • physical_id(impl Into<String>) / set_physical_id(Option<String>):
    required: true
    

    The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with ImportAsProvisionedProductOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about a request operation.

• On failure, responds with SdkError<ImportAsProvisionedProductError>

impl Client

pub fn list_accepted_portfolio_shares( &self ) -> ListAcceptedPortfolioSharesFluentBuilder

Constructs a fluent builder for the ListAcceptedPortfolioShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • portfolio_share_type(PortfolioShareType) / set_portfolio_share_type(Option<PortfolioShareType>):
    required: false
    

    The type of shared portfolios to list. The default is to list imported 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.

    
    
• On success, responds with ListAcceptedPortfolioSharesOutput with field(s):
  • portfolio_details(Option<Vec::<PortfolioDetail>>):

    Information about the portfolios.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListAcceptedPortfolioSharesError>

impl Client

pub fn list_budgets_for_resource(&self) -> ListBudgetsForResourceFluentBuilder

Constructs a fluent builder for the ListBudgetsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListBudgetsForResourceOutput with field(s):
  • budgets(Option<Vec::<BudgetDetail>>):

    Information about the associated budgets.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListBudgetsForResourceError>

impl Client

pub fn list_constraints_for_portfolio( &self ) -> ListConstraintsForPortfolioFluentBuilder

Constructs a fluent builder for the ListConstraintsForPortfolio operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: false
    

    The product identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListConstraintsForPortfolioOutput with field(s):
  • constraint_details(Option<Vec::<ConstraintDetail>>):

    Information about the constraints.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListConstraintsForPortfolioError>

impl Client

pub fn list_launch_paths(&self) -> ListLaunchPathsFluentBuilder

Constructs a fluent builder for the ListLaunchPaths operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListLaunchPathsOutput with field(s):
  • launch_path_summaries(Option<Vec::<LaunchPathSummary>>):

    Information about the launch path.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListLaunchPathsError>

impl Client

pub fn list_organization_portfolio_access( &self ) -> ListOrganizationPortfolioAccessFluentBuilder

Constructs a fluent builder for the ListOrganizationPortfolioAccess operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier. For example, port-2abcdext3y5fk.

    
    
  • organization_node_type(OrganizationNodeType) / set_organization_node_type(Option<OrganizationNodeType>):
    required: true
    

    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.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with ListOrganizationPortfolioAccessOutput with field(s):
  • organization_nodes(Option<Vec::<OrganizationNode>>):

    Displays information about the organization nodes.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListOrganizationPortfolioAccessError>

impl Client

pub fn list_portfolio_access(&self) -> ListPortfolioAccessFluentBuilder

Constructs a fluent builder for the ListPortfolioAccess operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • organization_parent_id(impl Into<String>) / set_organization_parent_id(Option<String>):
    required: false
    

    The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with ListPortfolioAccessOutput with field(s):
  • account_ids(Option<Vec::<String>>):

    Information about the Amazon Web Services accounts with access to the portfolio.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListPortfolioAccessError>

impl Client

pub fn list_portfolios(&self) -> ListPortfoliosFluentBuilder

Constructs a fluent builder for the ListPortfolios operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with ListPortfoliosOutput with field(s):
  • portfolio_details(Option<Vec::<PortfolioDetail>>):

    Information about the portfolios.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListPortfoliosError>

impl Client

pub fn list_portfolios_for_product( &self ) -> ListPortfoliosForProductFluentBuilder

Constructs a fluent builder for the ListPortfoliosForProduct operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with ListPortfoliosForProductOutput with field(s):
  • portfolio_details(Option<Vec::<PortfolioDetail>>):

    Information about the portfolios.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListPortfoliosForProductError>

impl Client

pub fn list_principals_for_portfolio( &self ) -> ListPrincipalsForPortfolioFluentBuilder

Constructs a fluent builder for the ListPrincipalsForPortfolio operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListPrincipalsForPortfolioOutput with field(s):
  • principals(Option<Vec::<Principal>>):

    The PrincipalARNs and corresponding PrincipalTypes associated with the portfolio.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListPrincipalsForPortfolioError>

impl Client

pub fn list_provisioned_product_plans( &self ) -> ListProvisionedProductPlansFluentBuilder

Constructs a fluent builder for the ListProvisionedProductPlans operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provision_product_id(impl Into<String>) / set_provision_product_id(Option<String>):
    required: false
    

    The product identifier.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • access_level_filter(AccessLevelFilter) / set_access_level_filter(Option<AccessLevelFilter>):
    required: false
    

    The access level to use to obtain results. The default is User.

    
    
• On success, responds with ListProvisionedProductPlansOutput with field(s):
  • provisioned_product_plans(Option<Vec::<ProvisionedProductPlanSummary>>):

    Information about the plans.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListProvisionedProductPlansError>

impl Client

pub fn list_provisioning_artifacts( &self ) -> ListProvisioningArtifactsFluentBuilder

Constructs a fluent builder for the ListProvisioningArtifacts operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
• On success, responds with ListProvisioningArtifactsOutput with field(s):
  • provisioning_artifact_details(Option<Vec::<ProvisioningArtifactDetail>>):

    Information about the provisioning artifacts.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListProvisioningArtifactsError>

impl Client

pub fn list_provisioning_artifacts_for_service_action( &self ) -> ListProvisioningArtifactsForServiceActionFluentBuilder

Constructs a fluent builder for the ListProvisioningArtifactsForServiceAction operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • service_action_id(impl Into<String>) / set_service_action_id(Option<String>):
    required: true
    

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with ListProvisioningArtifactsForServiceActionOutput with field(s):
  • provisioning_artifact_views(Option<Vec::<ProvisioningArtifactView>>):

    An array of objects with information about product views and provisioning artifacts.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListProvisioningArtifactsForServiceActionError>

impl Client

pub fn list_record_history(&self) -> ListRecordHistoryFluentBuilder

Constructs a fluent builder for the ListRecordHistory operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • access_level_filter(AccessLevelFilter) / set_access_level_filter(Option<AccessLevelFilter>):
    required: false
    

    The access level to use to obtain results. The default is User.

    
    
  • search_filter(ListRecordHistorySearchFilter) / set_search_filter(Option<ListRecordHistorySearchFilter>):
    required: false
    

    The search filter to scope the results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListRecordHistoryOutput with field(s):
  • record_details(Option<Vec::<RecordDetail>>):

    The records, in reverse chronological order.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListRecordHistoryError>

impl Client

pub fn list_resources_for_tag_option( &self ) -> ListResourcesForTagOptionFluentBuilder

Constructs a fluent builder for the ListResourcesForTagOption operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tag_option_id(impl Into<String>) / set_tag_option_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: false
    

    The resource type.

    • Portfolio

    • Product

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListResourcesForTagOptionOutput with field(s):
  • resource_details(Option<Vec::<ResourceDetail>>):

    Information about the resources.

  • page_token(Option<String>):

    The page token for the next set of results. To retrieve the first set of results, use null.

• On failure, responds with SdkError<ListResourcesForTagOptionError>

impl Client

pub fn list_service_actions(&self) -> ListServiceActionsFluentBuilder

Constructs a fluent builder for the ListServiceActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListServiceActionsOutput with field(s):
  • service_action_summaries(Option<Vec::<ServiceActionSummary>>):

    An object containing information about the service actions associated with the provisioning artifact.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListServiceActionsError>

impl Client

pub fn list_service_actions_for_provisioning_artifact( &self ) -> ListServiceActionsForProvisioningArtifactFluentBuilder

Constructs a fluent builder for the ListServiceActionsForProvisioningArtifact operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier. For example, prod-abcdzk7xy33qa.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with ListServiceActionsForProvisioningArtifactOutput with field(s):
  • service_action_summaries(Option<Vec::<ServiceActionSummary>>):

    An object containing information about the self-service actions associated with the provisioning artifact.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListServiceActionsForProvisioningArtifactError>

impl Client

pub fn list_stack_instances_for_provisioned_product( &self ) -> ListStackInstancesForProvisionedProductFluentBuilder

Constructs a fluent builder for the ListStackInstancesForProvisionedProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: true
    

    The identifier of the provisioned product.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
• On success, responds with ListStackInstancesForProvisionedProductOutput with field(s):
  • stack_instances(Option<Vec::<StackInstance>>):

    List of stack instances.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListStackInstancesForProvisionedProductError>

impl Client

pub fn list_tag_options(&self) -> ListTagOptionsFluentBuilder

Constructs a fluent builder for the ListTagOptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ListTagOptionsFilters) / set_filters(Option<ListTagOptionsFilters>):
    required: false
    

    The search filters. If no search filters are specified, the output includes all TagOptions.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ListTagOptionsOutput with field(s):
  • tag_option_details(Option<Vec::<TagOptionDetail>>):

    Information about the TagOptions.

  • page_token(Option<String>):

    The page token for the next set of results. To retrieve the first set of results, use null.

• On failure, responds with SdkError<ListTagOptionsError>

impl Client

pub fn notify_provision_product_engine_workflow_result( &self ) -> NotifyProvisionProductEngineWorkflowResultFluentBuilder

Constructs a fluent builder for the NotifyProvisionProductEngineWorkflowResult operation.

• The fluent builder is configurable:
  • workflow_token(impl Into<String>) / set_workflow_token(Option<String>):
    required: true
    

    The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

    
    
  • record_id(impl Into<String>) / set_record_id(Option<String>):
    required: true
    

    The identifier of the record.

    
    
  • status(EngineWorkflowStatus) / set_status(Option<EngineWorkflowStatus>):
    required: true
    

    The status of the provisioning engine execution.

    
    
  • failure_reason(impl Into<String>) / set_failure_reason(Option<String>):
    required: false
    

    The reason why the provisioning engine execution failed.

    
    
  • resource_identifier(EngineWorkflowResourceIdentifier) / set_resource_identifier(Option<EngineWorkflowResourceIdentifier>):
    required: false
    

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

    
    
  • outputs(RecordOutput) / set_outputs(Option<Vec::<RecordOutput>>):
    required: false
    

    The output of the provisioning engine execution.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    The idempotency token that identifies the provisioning engine execution.

    
    
• On success, responds with NotifyProvisionProductEngineWorkflowResultOutput
• On failure, responds with SdkError<NotifyProvisionProductEngineWorkflowResultError>

impl Client

pub fn notify_terminate_provisioned_product_engine_workflow_result( &self ) -> NotifyTerminateProvisionedProductEngineWorkflowResultFluentBuilder

Constructs a fluent builder for the NotifyTerminateProvisionedProductEngineWorkflowResult operation.

• The fluent builder is configurable:
  • workflow_token(impl Into<String>) / set_workflow_token(Option<String>):
    required: true
    

    The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

    
    
  • record_id(impl Into<String>) / set_record_id(Option<String>):
    required: true
    

    The identifier of the record.

    
    
  • status(EngineWorkflowStatus) / set_status(Option<EngineWorkflowStatus>):
    required: true
    

    The status of the terminate engine execution.

    
    
  • failure_reason(impl Into<String>) / set_failure_reason(Option<String>):
    required: false
    

    The reason why the terminate engine execution failed.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    The idempotency token that identifies the terminate engine execution.

    
    
• On success, responds with NotifyTerminateProvisionedProductEngineWorkflowResultOutput
• On failure, responds with SdkError<NotifyTerminateProvisionedProductEngineWorkflowResultError>

impl Client

pub fn notify_update_provisioned_product_engine_workflow_result( &self ) -> NotifyUpdateProvisionedProductEngineWorkflowResultFluentBuilder

Constructs a fluent builder for the NotifyUpdateProvisionedProductEngineWorkflowResult operation.

• The fluent builder is configurable:
  • workflow_token(impl Into<String>) / set_workflow_token(Option<String>):
    required: true
    

    The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

    
    
  • record_id(impl Into<String>) / set_record_id(Option<String>):
    required: true
    

    The identifier of the record.

    
    
  • status(EngineWorkflowStatus) / set_status(Option<EngineWorkflowStatus>):
    required: true
    

    The status of the update engine execution.

    
    
  • failure_reason(impl Into<String>) / set_failure_reason(Option<String>):
    required: false
    

    The reason why the update engine execution failed.

    
    
  • outputs(RecordOutput) / set_outputs(Option<Vec::<RecordOutput>>):
    required: false
    

    The output of the update engine execution.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    The idempotency token that identifies the update engine execution.

    
    
• On success, responds with NotifyUpdateProvisionedProductEngineWorkflowResultOutput
• On failure, responds with SdkError<NotifyUpdateProvisionedProductEngineWorkflowResultError>

impl Client

pub fn provision_product(&self) -> ProvisionProductFluentBuilder

Constructs a fluent builder for the ProvisionProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: false
    

    The product identifier. You must provide the name or ID, but not both.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: false
    

    The name of the product. You must provide the name or ID, but not both.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: false
    

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    
    
  • provisioning_artifact_name(impl Into<String>) / set_provisioning_artifact_name(Option<String>):
    required: false
    

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    
    
  • path_id(impl Into<String>) / set_path_id(Option<String>):
    required: false
    

    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.

    
    
  • path_name(impl Into<String>) / set_path_name(Option<String>):
    required: false
    

    The name of the path. You must provide the name or ID, but not both.

    
    
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: true
    

    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.

    
    
  • provisioning_parameters(ProvisioningParameter) / set_provisioning_parameters(Option<Vec::<ProvisioningParameter>>):
    required: false
    

    Parameters specified by the administrator that are required for provisioning the product.

    
    
  • provisioning_preferences(ProvisioningPreferences) / set_provisioning_preferences(Option<ProvisioningPreferences>):
    required: false
    

    An object that contains information about the provisioning preferences for a stack set.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags.

    
    
  • notification_arns(impl Into<String>) / set_notification_arns(Option<Vec::<String>>):
    required: false
    

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    
    
  • provision_token(impl Into<String>) / set_provision_token(Option<String>):
    required: true
    

    An idempotency token that uniquely identifies the provisioning request.

    
    
• On success, responds with ProvisionProductOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about the result of provisioning the product.

• On failure, responds with SdkError<ProvisionProductError>

impl Client

pub fn reject_portfolio_share(&self) -> RejectPortfolioShareFluentBuilder

Constructs a fluent builder for the RejectPortfolioShare operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • portfolio_share_type(PortfolioShareType) / set_portfolio_share_type(Option<PortfolioShareType>):
    required: false
    

    The type of shared portfolios to reject. The default is to reject imported 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

    
    
• On success, responds with RejectPortfolioShareOutput
• On failure, responds with SdkError<RejectPortfolioShareError>

impl Client

pub fn scan_provisioned_products(&self) -> ScanProvisionedProductsFluentBuilder

Constructs a fluent builder for the ScanProvisionedProducts operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • access_level_filter(AccessLevelFilter) / set_access_level_filter(Option<AccessLevelFilter>):
    required: false
    

    The access level to use to obtain results. The default is User.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with ScanProvisionedProductsOutput with field(s):
  • provisioned_products(Option<Vec::<ProvisionedProductDetail>>):

    Information about the provisioned products.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ScanProvisionedProductsError>

impl Client

pub fn search_products(&self) -> SearchProductsFluentBuilder

Constructs a fluent builder for the SearchProducts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • filters(ProductViewFilterBy, Vec::<String>) / set_filters(Option<HashMap::<ProductViewFilterBy, Vec::<String>>>):
    required: false
    

    The search filters. If no search filters are specified, the output includes all products to which the caller has access.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • sort_by(ProductViewSortBy) / set_sort_by(Option<ProductViewSortBy>):
    required: false
    

    The sort field. If no value is specified, the results are not sorted.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order. If no value is specified, the results are not sorted.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with SearchProductsOutput with field(s):
  • product_view_summaries(Option<Vec::<ProductViewSummary>>):

    Information about the product views.

  • product_view_aggregations(Option<HashMap::<String, Vec::<ProductViewAggregationValue>>>):

    The product view aggregations.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<SearchProductsError>

impl Client

pub fn search_products_as_admin(&self) -> SearchProductsAsAdminFluentBuilder

Constructs a fluent builder for the SearchProductsAsAdmin operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: false
    

    The portfolio identifier.

    
    
  • filters(ProductViewFilterBy, Vec::<String>) / set_filters(Option<HashMap::<ProductViewFilterBy, Vec::<String>>>):
    required: false
    

    The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

    
    
  • sort_by(ProductViewSortBy) / set_sort_by(Option<ProductViewSortBy>):
    required: false
    

    The sort field. If no value is specified, the results are not sorted.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order. If no value is specified, the results are not sorted.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • product_source(ProductSource) / set_product_source(Option<ProductSource>):
    required: false
    

    Access level of the source of the product.

    
    
• On success, responds with SearchProductsAsAdminOutput with field(s):
  • product_view_details(Option<Vec::<ProductViewDetail>>):

    Information about the product views.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<SearchProductsAsAdminError>

impl Client

pub fn search_provisioned_products( &self ) -> SearchProvisionedProductsFluentBuilder

Constructs a fluent builder for the SearchProvisionedProducts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • access_level_filter(AccessLevelFilter) / set_access_level_filter(Option<AccessLevelFilter>):
    required: false
    

    The access level to use to obtain results. The default is User.

    
    
  • filters(ProvisionedProductViewFilterBy, Vec::<String>) / set_filters(Option<HashMap::<ProvisionedProductViewFilterBy, Vec::<String>>>):
    required: false
    

    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”]

    
    
  • sort_by(impl Into<String>) / set_sort_by(Option<String>):
    required: false
    

    The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order. If no value is specified, the results are not sorted.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of items to return with this call.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    The page token for the next set of results. To retrieve the first set of results, use null.

    
    
• On success, responds with SearchProvisionedProductsOutput with field(s):
  • provisioned_products(Option<Vec::<ProvisionedProductAttribute>>):

    Information about the provisioned products.

  • total_results_count(i32):

    The number of provisioned products found.

  • next_page_token(Option<String>):

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<SearchProvisionedProductsError>

impl Client

pub fn terminate_provisioned_product( &self ) -> TerminateProvisionedProductFluentBuilder

Constructs a fluent builder for the TerminateProvisionedProduct operation.

• The fluent builder is configurable:
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: false
    

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    
    
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: false
    

    The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    
    
  • terminate_token(impl Into<String>) / set_terminate_token(Option<String>):
    required: true
    

    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.

    
    
  • ignore_errors(bool) / set_ignore_errors(Option<bool>):
    required: false
    

    If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • retain_physical_resources(bool) / set_retain_physical_resources(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with TerminateProvisionedProductOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about the result of this request.

• On failure, responds with SdkError<TerminateProvisionedProductError>

impl Client

pub fn update_constraint(&self) -> UpdateConstraintFluentBuilder

Constructs a fluent builder for the UpdateConstraint operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the constraint.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the constraint.

    
    
  • parameters(impl Into<String>) / set_parameters(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with UpdateConstraintOutput with field(s):
  • constraint_detail(Option<ConstraintDetail>):

    Information about the constraint.

  • constraint_parameters(Option<String>):

    The constraint parameters.

  • status(Option<Status>):

    The status of the current request.

• On failure, responds with SdkError<UpdateConstraintError>

impl Client

pub fn update_portfolio(&self) -> UpdatePortfolioFluentBuilder

Constructs a fluent builder for the UpdatePortfolio operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The portfolio identifier.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The name to use for display purposes.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the portfolio.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The updated name of the portfolio provider.

    
    
  • add_tags(Tag) / set_add_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add.

    
    
  • remove_tags(impl Into<String>) / set_remove_tags(Option<Vec::<String>>):
    required: false
    

    The tags to remove.

    
    
• On success, responds with UpdatePortfolioOutput with field(s):
  • portfolio_detail(Option<PortfolioDetail>):

    Information about the portfolio.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the portfolio.

• On failure, responds with SdkError<UpdatePortfolioError>

impl Client

pub fn update_portfolio_share(&self) -> UpdatePortfolioShareFluentBuilder

Constructs a fluent builder for the UpdatePortfolioShare operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • portfolio_id(impl Into<String>) / set_portfolio_id(Option<String>):
    required: true
    

    The unique identifier of the portfolio for which the share will be updated.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

    
    
  • organization_node(OrganizationNode) / set_organization_node(Option<OrganizationNode>):
    required: false
    

    Information about the organization node.

    
    
  • share_tag_options(bool) / set_share_tag_options(Option<bool>):
    required: false
    

    Enables or disables TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

    
    
  • share_principals(bool) / set_share_principals(Option<bool>):
    required: false
    

    A flag to enables or disables Principals sharing in the portfolio. If this field is not provided, the current state of the Principals sharing on the portfolio share will not be modified.

    
    
• On success, responds with UpdatePortfolioShareOutput with field(s):
  • portfolio_share_token(Option<String>):

    The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

  • status(Option<ShareStatus>):

    The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

• On failure, responds with SdkError<UpdatePortfolioShareError>

impl Client

pub fn update_product(&self) -> UpdateProductFluentBuilder

Constructs a fluent builder for the UpdateProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The updated product name.

    
    
  • owner(impl Into<String>) / set_owner(Option<String>):
    required: false
    

    The updated owner of the product.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the product.

    
    
  • distributor(impl Into<String>) / set_distributor(Option<String>):
    required: false
    

    The updated distributor of the product.

    
    
  • support_description(impl Into<String>) / set_support_description(Option<String>):
    required: false
    

    The updated support description for the product.

    
    
  • support_email(impl Into<String>) / set_support_email(Option<String>):
    required: false
    

    The updated support email for the product.

    
    
  • support_url(impl Into<String>) / set_support_url(Option<String>):
    required: false
    

    The updated support URL for the product.

    
    
  • add_tags(Tag) / set_add_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the product.

    
    
  • remove_tags(impl Into<String>) / set_remove_tags(Option<Vec::<String>>):
    required: false
    

    The tags to remove from the product.

    
    
  • source_connection(SourceConnection) / set_source_connection(Option<SourceConnection>):
    required: false
    

    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

    
    
• On success, responds with UpdateProductOutput with field(s):
  • product_view_detail(Option<ProductViewDetail>):

    Information about the product view.

  • tags(Option<Vec::<Tag>>):

    Information about the tags associated with the product.

• On failure, responds with SdkError<UpdateProductError>

impl Client

pub fn update_provisioned_product( &self ) -> UpdateProvisionedProductFluentBuilder

Constructs a fluent builder for the UpdateProvisionedProduct operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provisioned_product_name(impl Into<String>) / set_provisioned_product_name(Option<String>):
    required: false
    

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    
    
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: false
    

    The identifier of the provisioned product. You must provide the name or ID, but not both.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: false
    

    The identifier of the product. You must provide the name or ID, but not both.

    
    
  • product_name(impl Into<String>) / set_product_name(Option<String>):
    required: false
    

    The name of the product. You must provide the name or ID, but not both.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: false
    

    The identifier of the provisioning artifact.

    
    
  • provisioning_artifact_name(impl Into<String>) / set_provisioning_artifact_name(Option<String>):
    required: false
    

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    
    
  • path_id(impl Into<String>) / set_path_id(Option<String>):
    required: false
    

    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.

    
    
  • path_name(impl Into<String>) / set_path_name(Option<String>):
    required: false
    

    The name of the path. You must provide the name or ID, but not both.

    
    
  • provisioning_parameters(UpdateProvisioningParameter) / set_provisioning_parameters(Option<Vec::<UpdateProvisioningParameter>>):
    required: false
    

    The new parameters.

    
    
  • provisioning_preferences(UpdateProvisioningPreferences) / set_provisioning_preferences(Option<UpdateProvisioningPreferences>):
    required: false
    

    An object that contains information about the provisioning preferences for a stack set.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    
    
  • update_token(impl Into<String>) / set_update_token(Option<String>):
    required: true
    

    The idempotency token that uniquely identifies the provisioning update request.

    
    
• On success, responds with UpdateProvisionedProductOutput with field(s):
  • record_detail(Option<RecordDetail>):

    Information about the result of the request.

• On failure, responds with SdkError<UpdateProvisionedProductError>

impl Client

pub fn update_provisioned_product_properties( &self ) -> UpdateProvisionedProductPropertiesFluentBuilder

Constructs a fluent builder for the UpdateProvisionedProductProperties operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • provisioned_product_id(impl Into<String>) / set_provisioned_product_id(Option<String>):
    required: true
    

    The identifier of the provisioned product.

    
    
  • provisioned_product_properties(PropertyKey, impl Into<String>) / set_provisioned_product_properties(Option<HashMap::<PropertyKey, String>>):
    required: true
    

    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.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    The idempotency token that uniquely identifies the provisioning product update request.

    
    
• On success, responds with UpdateProvisionedProductPropertiesOutput with field(s):
  • provisioned_product_id(Option<String>):

    The provisioned product identifier.

  • provisioned_product_properties(Option<HashMap::<PropertyKey, String>>):

    A map that contains the properties updated.

  • record_id(Option<String>):

    The identifier of the record.

  • status(Option<RecordStatus>):

    The status of the request.

• On failure, responds with SdkError<UpdateProvisionedProductPropertiesError>

impl Client

pub fn update_provisioning_artifact( &self ) -> UpdateProvisioningArtifactFluentBuilder

Constructs a fluent builder for the UpdateProvisioningArtifact operation.

• The fluent builder is configurable:
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product identifier.

    
    
  • provisioning_artifact_id(impl Into<String>) / set_provisioning_artifact_id(Option<String>):
    required: true
    

    The identifier of the provisioning artifact.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The updated name of the provisioning artifact.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the provisioning artifact.

    
    
  • active(bool) / set_active(Option<bool>):
    required: false
    

    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.

    
    
  • guidance(ProvisioningArtifactGuidance) / set_guidance(Option<ProvisioningArtifactGuidance>):
    required: false
    

    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.

    
    
• On success, responds with UpdateProvisioningArtifactOutput with field(s):
  • provisioning_artifact_detail(Option<ProvisioningArtifactDetail>):

    Information about the provisioning artifact.

  • info(Option<HashMap::<String, String>>):

    The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

  • status(Option<Status>):

    The status of the current request.

• On failure, responds with SdkError<UpdateProvisioningArtifactError>

impl Client

pub fn update_service_action(&self) -> UpdateServiceActionFluentBuilder

Constructs a fluent builder for the UpdateServiceAction operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The self-service action identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The self-service action name.

    
    
  • definition(ServiceActionDefinitionKey, impl Into<String>) / set_definition(Option<HashMap::<ServiceActionDefinitionKey, String>>):
    required: false
    

    A map that defines the self-service action.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The self-service action description.

    
    
  • accept_language(impl Into<String>) / set_accept_language(Option<String>):
    required: false
    

    The language code.

    • jp - Japanese

    • zh - Chinese

    
    
• On success, responds with UpdateServiceActionOutput with field(s):
  • service_action_detail(Option<ServiceActionDetail>):

    Detailed information about the self-service action.

• On failure, responds with SdkError<UpdateServiceActionError>

impl Client

pub fn update_tag_option(&self) -> UpdateTagOptionFluentBuilder

Constructs a fluent builder for the UpdateTagOption operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The TagOption identifier.

    
    
  • value(impl Into<String>) / set_value(Option<String>):
    required: false
    

    The updated value.

    
    
  • active(bool) / set_active(Option<bool>):
    required: false
    

    The updated active state.

    
    
• On success, responds with UpdateTagOptionOutput with field(s):
  • tag_option_detail(Option<TagOptionDetail>):

    Information about the TagOption.

• On failure, responds with SdkError<UpdateTagOptionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.