Describe Product As Admin

servicecatalog_describe_product_as_admin

R Documentation

Gets information about the specified product

Description

Gets information about the specified product. This operation is run with administrator access.

Usage

servicecatalog_describe_product_as_admin(AcceptLanguage, Id, Name,
  SourcePortfolioId)

Arguments

AcceptLanguage

The language code.

• jp - Japanese

• zh - Chinese

Id

The product identifier.

Name

The product name.

SourcePortfolioId

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.

Value

A list with the following syntax:

list(
  ProductViewDetail = list(
    ProductViewSummary = list(
      Id = "string",
      ProductId = "string",
      Name = "string",
      Owner = "string",
      ShortDescription = "string",
      Type = "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE"|"TERRAFORM_OPEN_SOURCE"|"TERRAFORM_CLOUD"|"EXTERNAL",
      Distributor = "string",
      HasDefaultPath = TRUE|FALSE,
      SupportEmail = "string",
      SupportDescription = "string",
      SupportUrl = "string"
    ),
    Status = "AVAILABLE"|"CREATING"|"FAILED",
    ProductARN = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    SourceConnection = list(
      Type = "CODESTAR",
      ConnectionParameters = list(
        CodeStar = list(
          ConnectionArn = "string",
          Repository = "string",
          Branch = "string",
          ArtifactPath = "string"
        )
      ),
      LastSync = list(
        LastSyncTime = as.POSIXct(
          "2015-01-01"
        ),
        LastSyncStatus = "SUCCEEDED"|"FAILED",
        LastSyncStatusMessage = "string",
        LastSuccessfulSyncTime = as.POSIXct(
          "2015-01-01"
        ),
        LastSuccessfulSyncProvisioningArtifactId = "string"
      )
    )
  ),
  ProvisioningArtifactSummaries = list(
    list(
      Id = "string",
      Name = "string",
      Description = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      ProvisioningArtifactMetadata = list(
        "string"
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  TagOptions = list(
    list(
      Key = "string",
      Value = "string",
      Active = TRUE|FALSE,
      Id = "string",
      Owner = "string"
    )
  ),
  Budgets = list(
    list(
      BudgetName = "string"
    )
  )
)

Request syntax

svc$describe_product_as_admin(
  AcceptLanguage = "string",
  Id = "string",
  Name = "string",
  SourcePortfolioId = "string"
)