servicecatalog_describe_provisioning_parameters: Gets information about the configuration required to...

Description Usage Arguments Value Request syntax

View source: R/servicecatalog_operations.R

Description

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to provision_product, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Usage

1
2
3
servicecatalog_describe_provisioning_parameters(AcceptLanguage,
  ProductId, ProductName, ProvisioningArtifactId,
  ProvisioningArtifactName, PathId, PathName)

Arguments

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

ProductId

The product identifier. You must provide the product 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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
list(
  ProvisioningArtifactParameters = list(
    list(
      ParameterKey = "string",
      DefaultValue = "string",
      ParameterType = "string",
      IsNoEcho = TRUE|FALSE,
      Description = "string",
      ParameterConstraints = list(
        AllowedValues = list(
          "string"
        ),
        AllowedPattern = "string",
        ConstraintDescription = "string",
        MaxLength = "string",
        MinLength = "string",
        MaxValue = "string",
        MinValue = "string"
      )
    )
  ),
  ConstraintSummaries = list(
    list(
      Type = "string",
      Description = "string"
    )
  ),
  UsageInstructions = list(
    list(
      Type = "string",
      Value = "string"
    )
  ),
  TagOptions = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  ProvisioningArtifactPreferences = list(
    StackSetAccounts = list(
      "string"
    ),
    StackSetRegions = list(
      "string"
    )
  ),
  ProvisioningArtifactOutputs = list(
    list(
      Key = "string",
      Description = "string"
    )
  )
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$describe_provisioning_parameters(
  AcceptLanguage = "string",
  ProductId = "string",
  ProductName = "string",
  ProvisioningArtifactId = "string",
  ProvisioningArtifactName = "string",
  PathId = "string",
  PathName = "string"
)

paws.management documentation built on March 8, 2021, 1:07 a.m.