Skip to content

Provisions the specified product

Description

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using describe_record.

If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

Usage

servicecatalog_provision_product(AcceptLanguage, ProductId, ProductName,
  ProvisioningArtifactId, ProvisioningArtifactName, PathId, PathName,
  ProvisionedProductName, ProvisioningParameters, ProvisioningPreferences,
  Tags, NotificationArns, ProvisionToken)

Arguments

  • AcceptLanguage

    The language code.

    • jp - Japanese
    • zh - Chinese

  • ProductId

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

  • ProductName

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

  • ProvisioningArtifactId

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

  • ProvisioningArtifactName

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

  • PathId

    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 list_launch_paths. You must provide the name or ID, but not both.

  • PathName

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

  • ProvisionedProductName

    [required] 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.

  • ProvisioningParameters

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

  • ProvisioningPreferences

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

  • Tags

    One or more tags.

  • NotificationArns

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

  • ProvisionToken

    [required] An idempotency token that uniquely identifies the provisioning request.

Value

A list with the following syntax:

list(
  RecordDetail = list(
    RecordId = "string",
    ProvisionedProductName = "string",
    Status = "CREATED"|"IN_PROGRESS"|"IN_PROGRESS_IN_ERROR"|"SUCCEEDED"|"FAILED",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    ProvisionedProductType = "string",
    RecordType = "string",
    ProvisionedProductId = "string",
    ProductId = "string",
    ProvisioningArtifactId = "string",
    PathId = "string",
    RecordErrors = list(
      list(
        Code = "string",
        Description = "string"
      )
    ),
    RecordTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    LaunchRoleArn = "string"
  )
)

Request syntax

svc$provision_product(
  AcceptLanguage = "string",
  ProductId = "string",
  ProductName = "string",
  ProvisioningArtifactId = "string",
  ProvisioningArtifactName = "string",
  PathId = "string",
  PathName = "string",
  ProvisionedProductName = "string",
  ProvisioningParameters = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ProvisioningPreferences = list(
    StackSetAccounts = list(
      "string"
    ),
    StackSetRegions = list(
      "string"
    ),
    StackSetFailureToleranceCount = 123,
    StackSetFailureTolerancePercentage = 123,
    StackSetMaxConcurrencyCount = 123,
    StackSetMaxConcurrencyPercentage = 123
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  NotificationArns = list(
    "string"
  ),
  ProvisionToken = "string"
)