Struct aws_sdk_servicecatalog::client::Client

source · [−]
pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_servicecatalog::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_servicecatalog::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_servicecatalog::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AcceptPortfolioShare operation.

Constructs a fluent builder for the AssociateBudgetWithResource operation.

Constructs a fluent builder for the AssociatePrincipalWithPortfolio operation.

Constructs a fluent builder for the AssociateProductWithPortfolio operation.

Constructs a fluent builder for the AssociateServiceActionWithProvisioningArtifact operation.

Constructs a fluent builder for the AssociateTagOptionWithResource operation.

Constructs a fluent builder for the BatchAssociateServiceActionWithProvisioningArtifact operation.

Constructs a fluent builder for the BatchDisassociateServiceActionFromProvisioningArtifact operation.

Constructs a fluent builder for the CopyProduct operation.

Constructs a fluent builder for the CreateConstraint operation.

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

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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

      The portfolio identifier.

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

      The product identifier.

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

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can’t use both.

      Specify the RoleArn property as follows:

      {“RoleArn” : “arn:aws:iam::123456789012:role/LaunchRole”}

      Specify the LocalRoleName property as follows:

      {“LocalRoleName”: “SCBasicLaunchRole”}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {“NotificationArns” : [“arn:aws:sns:us-east-1:123456789012:Topic”]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {“Version”:“2.0”,“Properties”:{“TagUpdateOnProvisionedProduct”:“String”}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {“Version”: “String”, “Properties”: {“AccountList”: [ “String” ], “RegionList”: [ “String” ], “AdminRole”: “String”, “ExecutionRole”: “String”}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

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

      The type of constraint.

      • LAUNCH

      • NOTIFICATION

      • RESOURCE_UPDATE

      • STACKSET

      • TEMPLATE

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

      The description of the constraint.

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

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

  • On success, responds with CreateConstraintOutput with field(s):
  • On failure, responds with SdkError<CreateConstraintError>

Constructs a fluent builder for the CreatePortfolio operation.

Constructs a fluent builder for the CreatePortfolioShare operation.

Constructs a fluent builder for the CreateProduct operation.

Constructs a fluent builder for the CreateProvisionedProductPlan operation.

Constructs a fluent builder for the CreateProvisioningArtifact operation.

Constructs a fluent builder for the CreateServiceAction operation.

Constructs a fluent builder for the CreateTagOption operation.

Constructs a fluent builder for the DeleteConstraint operation.

Constructs a fluent builder for the DeletePortfolio operation.

Constructs a fluent builder for the DeletePortfolioShare operation.

Constructs a fluent builder for the DeleteProduct operation.

Constructs a fluent builder for the DeleteProvisionedProductPlan operation.

Constructs a fluent builder for the DeleteProvisioningArtifact operation.

Constructs a fluent builder for the DeleteServiceAction operation.

Constructs a fluent builder for the DeleteTagOption operation.

Constructs a fluent builder for the DescribeConstraint operation.

Constructs a fluent builder for the DescribeCopyProductStatus operation.

Constructs a fluent builder for the DescribePortfolio operation.

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

Constructs a fluent builder for the DescribePortfolioShareStatus operation.

Constructs a fluent builder for the DescribeProduct operation.

Constructs a fluent builder for the DescribeProductAsAdmin operation.

Constructs a fluent builder for the DescribeProductView operation.

Constructs a fluent builder for the DescribeProvisionedProduct operation.

Constructs a fluent builder for the DescribeProvisionedProductPlan operation.

Constructs a fluent builder for the DescribeProvisioningArtifact operation.

Constructs a fluent builder for the DescribeProvisioningParameters operation.

Constructs a fluent builder for the DescribeRecord operation.

Constructs a fluent builder for the DescribeServiceAction operation.

Constructs a fluent builder for the DescribeServiceActionExecutionParameters operation.

Constructs a fluent builder for the DescribeTagOption operation.

Constructs a fluent builder for the DisableAWSOrganizationsAccess operation.

Constructs a fluent builder for the DisassociateBudgetFromResource operation.

Constructs a fluent builder for the DisassociatePrincipalFromPortfolio operation.

Constructs a fluent builder for the DisassociateProductFromPortfolio operation.

Constructs a fluent builder for the DisassociateServiceActionFromProvisioningArtifact operation.

Constructs a fluent builder for the DisassociateTagOptionFromResource operation.

Constructs a fluent builder for the EnableAWSOrganizationsAccess operation.

Constructs a fluent builder for the ExecuteProvisionedProductPlan operation.

Constructs a fluent builder for the ExecuteProvisionedProductServiceAction operation.

Constructs a fluent builder for the GetAWSOrganizationsAccessStatus operation.

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

Constructs a fluent builder for the ImportAsProvisionedProduct operation.

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

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

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

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

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

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

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

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

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

Constructs a fluent builder for the ListProvisionedProductPlans operation.

Constructs a fluent builder for the ListProvisioningArtifacts operation.

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

Constructs a fluent builder for the ListRecordHistory operation.

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

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

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

Constructs a fluent builder for the ListStackInstancesForProvisionedProduct operation.

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

Constructs a fluent builder for the ProvisionProduct operation.

Constructs a fluent builder for the RejectPortfolioShare operation.

Constructs a fluent builder for the ScanProvisionedProducts operation.

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

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

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

Constructs a fluent builder for the TerminateProvisionedProduct operation.

Constructs a fluent builder for the UpdateConstraint operation.

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

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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

      The identifier of the constraint.

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

      The updated description of the constraint.

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

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can’t use both.

      Specify the RoleArn property as follows:

      {“RoleArn” : “arn:aws:iam::123456789012:role/LaunchRole”}

      Specify the LocalRoleName property as follows:

      {“LocalRoleName”: “SCBasicLaunchRole”}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {“NotificationArns” : [“arn:aws:sns:us-east-1:123456789012:Topic”]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {“Version”:“2.0”,“Properties”:{“TagUpdateOnProvisionedProduct”:“String”}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {“Version”: “String”, “Properties”: {“AccountList”: [ “String” ], “RegionList”: [ “String” ], “AdminRole”: “String”, “ExecutionRole”: “String”}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

  • On success, responds with UpdateConstraintOutput with field(s):
  • On failure, responds with SdkError<UpdateConstraintError>

Constructs a fluent builder for the UpdatePortfolio operation.

Constructs a fluent builder for the UpdatePortfolioShare operation.

Constructs a fluent builder for the UpdateProduct operation.

Constructs a fluent builder for the UpdateProvisionedProduct operation.

Constructs a fluent builder for the UpdateProvisionedProductProperties operation.

Constructs a fluent builder for the UpdateProvisioningArtifact operation.

Constructs a fluent builder for the UpdateServiceAction operation.

Constructs a fluent builder for the UpdateTagOption operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more