Skip to content

Describe Provisioning Artifact

servicecatalog_describe_provisioning_artifact R Documentation

Gets information about the specified provisioning artifact (also known as a version) for the specified product

Description

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Usage

servicecatalog_describe_provisioning_artifact(AcceptLanguage,
  ProvisioningArtifactId, ProductId, ProvisioningArtifactName,
  ProductName, Verbose, IncludeProvisioningArtifactParameters)

Arguments

AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

ProvisioningArtifactId

The identifier of the provisioning artifact.

ProductId

The product identifier.

ProvisioningArtifactName

The provisioning artifact name.

ProductName

The product name.

Verbose

Indicates whether a verbose level of detail is enabled.

IncludeProvisioningArtifactParameters

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

Value

A list with the following syntax:

list(
  ProvisioningArtifactDetail = list(
    Id = "string",
    Name = "string",
    Description = "string",
    Type = "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE_AMI"|"MARKETPLACE_CAR"|"TERRAFORM_OPEN_SOURCE"|"TERRAFORM_CLOUD"|"EXTERNAL",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    Active = TRUE|FALSE,
    Guidance = "DEFAULT"|"DEPRECATED",
    SourceRevision = "string"
  ),
  Info = list(
    "string"
  ),
  Status = "AVAILABLE"|"CREATING"|"FAILED",
  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"
      )
    )
  )
)

Request syntax

svc$describe_provisioning_artifact(
  AcceptLanguage = "string",
  ProvisioningArtifactId = "string",
  ProductId = "string",
  ProvisioningArtifactName = "string",
  ProductName = "string",
  Verbose = TRUE|FALSE,
  IncludeProvisioningArtifactParameters = TRUE|FALSE
)