DescribePortfolio - Amazon Service Catalog
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribePortfolio

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

Request Syntax

{ "AcceptLanguage": "string", "Id": "string" }

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

Id

The portfolio identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

Response Syntax

{ "Budgets": [ { "BudgetName": "string" } ], "PortfolioDetail": { "ARN": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "Id": "string", "ProviderName": "string" }, "TagOptions": [ { "Active": boolean, "Id": "string", "Key": "string", "Owner": "string", "Value": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Budgets

Information about the associated budgets.

Type: Array of BudgetDetail objects

PortfolioDetail

Information about the portfolio.

Type: PortfolioDetail object

TagOptions

Information about the TagOptions associated with the portfolio.

Type: Array of TagOptionDetail objects

Tags

Information about the tags associated with the portfolio.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Errors

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: