Icon

AWS Service Catalog (version v1.*.*)

accept_portfolio_share

Accepts an offer to share the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"PortfolioShareType" : "The type of shared portfolios to accept. The default is to accept imported portfolios. \n AWS_ORGANIZATIONS - Accept portfolios shared by the master account of your organization. \n IMPORTED - Accept imported portfolios. \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) \nFor example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS "
}

associate_budget_with_resource

Associates the specified budget with the specified resource.

Parameters

$body

Type: object

{
"ResourceId" : " The resource identifier. Either a portfolio-id or a product-id.",
"BudgetName" : "The name of the budget you want to associate."
}

associate_principal_with_portfolio

Associates the specified principal ARN with the specified portfolio.

Parameters

$body

Type: object

{
"PrincipalARN" : "The ARN of the principal (IAM user, role, or group).",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"PrincipalType" : "The principal type. The supported value is IAM."
}

associate_product_with_portfolio

Associates the specified product with the specified portfolio.

Parameters

$body

Type: object

{
"SourcePortfolioId" : "The identifier of the source portfolio.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"ProductId" : "The product identifier."
}

associate_service_action_with_provisioning_artifact

Associates a self-service action with a provisioning artifact.

Parameters

$body

Type: object

{
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier. For example, prod-abcdzk7xy33qa.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne."
}

associate_tag_option_with_resource

Associate the specified TagOption with the specified portfolio or product.

Parameters

$body

Type: object

{
"TagOptionId" : "The TagOption identifier.",
"ResourceId" : "The resource identifier."
}

batch_associate_service_action_with_provisioning_artifact

Associates multiple self-service actions with provisioning artifacts.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ServiceActionAssociations" : [ {
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"ProductId" : "The product identifier. For example, prod-abcdzk7xy33qa.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne."
} ]
}

batch_disassociate_service_action_from_provisioning_artifact

Disassociates a batch of self-service actions from the specified provisioning artifact.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ServiceActionAssociations" : [ {
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"ProductId" : "The product identifier. For example, prod-abcdzk7xy33qa.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne."
} ]
}

copy_product

Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same region or another region.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Parameters

$body

Type: object

{
"IdempotencyToken" : " A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. ",
"TargetProductId" : "The identifier of the target product. By default, a new product is created.",
"SourceProductArn" : "The Amazon Resource Name (ARN) of the source product.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SourceProvisioningArtifactIdentifiers" : [ {
"<string>" : "string"
} ],
"CopyOptions" : [ "string. Possible values: CopyTags" ],
"TargetProductName" : "A name for the target product. The default is the name of the source product."
}

create_constraint

Creates a constraint.

Parameters

$body

Type: object

{
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"Type" : "The type of constraint. \n LAUNCH \n NOTIFICATION \n RESOURCE_UPDATE \n STACKSET \n TEMPLATE ",
"Parameters" : "The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH \nSpecify the RoleArn property as follows: \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"} \nYou cannot have both a LAUNCH and a STACKSET constraint. \nYou also cannot have more than one LAUNCH constraint on a product and portfolio. NOTIFICATION \nSpecify the NotificationArns property as follows: \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]} RESOURCE_UPDATE \nSpecify the TagUpdatesOnProvisionedProduct property as follows: \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}} \nThe TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED. STACKSET \nSpecify the Parameters property as follows: \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}} \nYou cannot have both a LAUNCH and a STACKSET constraint. \nYou also cannot have more than one STACKSET constraint on a product and portfolio. \nProducts with a STACKSET constraint will launch an AWS CloudFormation stack set. TEMPLATE \nSpecify the Rules property. For more information, see Template Constraint Rules.",
"Description" : "The description of the constraint.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"ProductId" : "The product identifier."
}

create_portfolio

Creates a portfolio.

Parameters

$body

Type: object

{
"ProviderName" : "The name of the portfolio provider.",
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"Description" : "The description of the portfolio.",
"DisplayName" : "The name to use for display purposes.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Tags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ]
}

create_portfolio_share

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

Parameters

$body

Type: object

{
"AccountId" : "The AWS account ID. For example, 123456789012.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"OrganizationNode" : {
"Type" : "The organization node type.",
"Value" : "The identifier of the organization node."
}
}

create_product

Creates a product.

Parameters

$body

Type: object

{
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"Owner" : "The owner of the product.",
"SupportDescription" : "The support information about the product.",
"Description" : "The description of the product.",
"Distributor" : "The distributor of the product.",
"SupportEmail" : "The contact email for product support.",
"ProductType" : "The type of product.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SupportUrl" : "The contact URL for product support.",
"Tags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"Name" : "The name of the product.",
"ProvisioningArtifactParameters" : {
"Type" : "The type of provisioning artifact. \n CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template \n MARKETPLACE_AMI - AWS Marketplace AMI \n MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources ",
"Description" : "The description of the provisioning artifact, including how it differs from the previous provisioning artifact.",
"DisableTemplateValidation" : "If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.",
"Info" : "The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows: \n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\" ",
"Name" : "The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed."
}
}

create_provisioned_product_plan

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Parameters

$body

Type: object

{
"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 ListLaunchPaths.",
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"ProvisioningParameters" : [ {
"UsePreviousValue" : "If set to true, Value is ignored and the previous parameter value is kept.",
"Value" : "The parameter value.",
"Key" : "The parameter key."
} ],
"PlanType" : "The plan type.",
"NotificationArns" : [ "string" ],
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"PlanName" : "The name of the plan.",
"Tags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"ProvisionedProductName" : "A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact."
}

create_provisioning_artifact

Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.

Parameters

$body

Type: object

{
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"Parameters" : {
"Type" : "The type of provisioning artifact. \n CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template \n MARKETPLACE_AMI - AWS Marketplace AMI \n MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources ",
"Description" : "The description of the provisioning artifact, including how it differs from the previous provisioning artifact.",
"DisableTemplateValidation" : "If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.",
"Info" : "The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows: \n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\" ",
"Name" : "The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed."
},
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier."
}

create_service_action

Creates a self-service action.

Parameters

$body

Type: object

{
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"Description" : "The self-service action description.",
"Definition" : "The self-service action definition. Can be one of the following: Name \nThe name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance. Version \nThe AWS Systems Manager automation document version. For example, \"Version\": \"1\" AssumeRole \nThe Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, \"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\". \nTo reuse the provisioned product launch role, set to \"AssumeRole\": \"LAUNCH_ROLE\". Parameters \nThe list of parameters in JSON format. \nFor example: [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}].",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"DefinitionType" : "The service action definition type. For example, SSM_AUTOMATION.",
"Name" : "The self-service action name."
}

create_tag_option

Creates a TagOption.

Parameters

$body

Type: object

{
"Value" : "The TagOption value.",
"Key" : "The TagOption key."
}

delete_constraint

Deletes the specified constraint.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The identifier of the constraint."
}

delete_portfolio

Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The portfolio identifier."
}

delete_portfolio_share

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an Organization.

Parameters

$body

Type: object

{
"AccountId" : "The AWS account ID.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"OrganizationNode" : {
"Type" : "The organization node type.",
"Value" : "The identifier of the organization node."
}
}

delete_product

Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The product identifier."
}

delete_provisioned_product_plan

Deletes the specified plan.

Parameters

$body

Type: object

{
"IgnoreErrors" : "If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.",
"PlanId" : "The plan identifier.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

delete_provisioning_artifact

Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact."
}

delete_service_action

Deletes a self-service action.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The self-service action identifier. For example, act-fs7abcd89wxyz."
}

delete_tag_option

Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.

Parameters

$body

Type: object

{
"Id" : "The TagOption identifier."
}

describe_constraint

Gets information about the specified constraint.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The identifier of the constraint."
}

describe_copy_product_status

Gets the status of the specified copy product operation.

Parameters

$body

Type: object

{
"CopyProductToken" : "The token for the copy product operation. This token is returned by CopyProduct.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

describe_portfolio

Gets information about the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The portfolio identifier."
}

describe_portfolio_share_status

Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization.

Parameters

$body

Type: object

{
"PortfolioShareToken" : "The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare."
}

describe_product

Gets information about the specified product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The product identifier."
}

describe_product_as_admin

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

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The product identifier."
}

describe_product_view

Gets information about the specified product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The product view identifier."
}

describe_provisioned_product

Gets information about the specified provisioned product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The provisioned product identifier."
}

describe_provisioned_product_plan

Gets information about the resource changes for the specified plan.

Parameters

$body

Type: object

{
"PageSize" : "The maximum number of items to return with this call.",
"PlanId" : "The plan identifier.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null."
}

describe_provisioning_artifact

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

Parameters

$body

Type: object

{
"Verbose" : "Indicates whether a verbose level of detail is enabled.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact."
}

describe_provisioning_parameters

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 ProvisionProduct, 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.

Parameters

$body

Type: object

{
"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 ListLaunchPaths.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact."
}

describe_record

Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Parameters

$body

Type: object

{
"PageSize" : "The maximum number of items to return with this call.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null.",
"Id" : "The record identifier of the provisioned product. This identifier is returned by the request operation."
}

describe_service_action

Describes a self-service action.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The self-service action identifier."
}

describe_service_action_execution_parameters

Parameters

$body

Type: object

{
"ServiceActionId" : "Required string",
"AcceptLanguage" : "string",
"ProvisionedProductId" : "Required string"
}

describe_tag_option

Gets information about the specified TagOption.

Parameters

$body

Type: object

{
"Id" : "The TagOption identifier."
}

disable_aws_organizations_access

Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization.

Parameters

$body

Type: object

{ }

disassociate_budget_from_resource

Disassociates the specified budget from the specified resource.

Parameters

$body

Type: object

{
"ResourceId" : "The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.",
"BudgetName" : "The name of the budget you want to disassociate."
}

disassociate_principal_from_portfolio

Disassociates a previously associated principal ARN from a specified portfolio.

Parameters

$body

Type: object

{
"PrincipalARN" : "The ARN of the principal (IAM user, role, or group).",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier."
}

disassociate_product_from_portfolio

Disassociates the specified product from the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"ProductId" : "The product identifier."
}

disassociate_service_action_from_provisioning_artifact

Disassociates the specified self-service action association from the specified provisioning artifact.

Parameters

$body

Type: object

{
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier. For example, prod-abcdzk7xy33qa.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne."
}

disassociate_tag_option_from_resource

Disassociates the specified TagOption from the specified resource.

Parameters

$body

Type: object

{
"TagOptionId" : "The TagOption identifier.",
"ResourceId" : "The resource identifier."
}

enable_aws_organizations_access

Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization.
By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

Parameters

$body

Type: object

{ }

execute_provisioned_product_plan

Provisions or modifies a product based on the resource changes for the specified plan.

Parameters

$body

Type: object

{
"IdempotencyToken" : "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.",
"PlanId" : "The plan identifier.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

execute_provisioned_product_service_action

Executes a self-service action against a provisioned product.

Parameters

$body

Type: object

{
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"Parameters" : "object",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProvisionedProductId" : "The identifier of the provisioned product.",
"ExecuteToken" : "An idempotency token that uniquely identifies the execute request."
}

get_aws_organizations_access_status

Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization.

Parameters

$body

Type: object

{ }

list_accepted_portfolio_shares

Lists all portfolios for which sharing was accepted by this account.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioShareType" : "The type of shared portfolios to list. The default is to list imported portfolios. \n AWS_ORGANIZATIONS - List portfolios shared by the master account of your organization \n AWS_SERVICECATALOG - List default portfolios \n IMPORTED - List imported portfolios "
}

list_budgets_for_resource

Lists all the budgets associated to the specified resource.

Parameters

$body

Type: object

{
"PageSize" : "The maximum number of items to return with this call.",
"ResourceId" : "The resource identifier.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null."
}

list_constraints_for_portfolio

Lists the constraints for the specified portfolio and product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"ProductId" : "The product identifier."
}

list_launch_paths

Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier."
}

list_organization_portfolio_access

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization.

Parameters

$body

Type: object

{
"OrganizationNodeType" : "The organization node type that will be returned in the output. \n ORGANIZATION - Organization that has access to the portfolio. \n ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization. \n ACCOUNT - Account that has access to the portfolio within your organization. ",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier. For example, port-2abcdext3y5fk."
}

list_portfolio_access

Lists the account IDs that have access to the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier."
}

list_portfolios

Lists all portfolios in the catalog.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

list_portfolios_for_product

Lists all portfolios that the specified product is associated with.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier."
}

list_principals_for_portfolio

Lists all principal ARNs associated with the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier."
}

list_provisioned_product_plans

Lists the plans for the specified provisioned product or all plans to which the user has access.

Parameters

$body

Type: object

{
"ProvisionProductId" : "The product identifier.",
"AccessLevelFilter" : {
"Value" : "The user to which the access level applies. The only supported value is Self.",
"Key" : "The access level. \n Account - Filter results based on the account. \n Role - Filter results based on the federated role of the specified user. \n User - Filter results based on the specified user. "
},
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

list_provisioning_artifacts

Lists all provisioning artifacts (also known as versions) for the specified product.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier."
}

list_provisioning_artifacts_for_service_action

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

Parameters

$body

Type: object

{
"ServiceActionId" : "The self-service action identifier. For example, act-fs7abcd89wxyz.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

list_record_history

Lists the specified requests or all performed requests.

Parameters

$body

Type: object

{
"AccessLevelFilter" : {
"Value" : "The user to which the access level applies. The only supported value is Self.",
"Key" : "The access level. \n Account - Filter results based on the account. \n Role - Filter results based on the federated role of the specified user. \n User - Filter results based on the specified user. "
},
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SearchFilter" : {
"Value" : "The filter value.",
"Key" : "The filter key. \n product - Filter results based on the specified product identifier. \n provisionedproduct - Filter results based on the provisioned product identifier. "
}
}

list_resources_for_tag_option

Lists the resources associated with the specified TagOption.

Parameters

$body

Type: object

{
"TagOptionId" : "The TagOption identifier.",
"ResourceType" : "The resource type. \n Portfolio \n Product "
}

list_service_actions

Lists all self-service actions.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

list_service_actions_for_provisioning_artifact

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier. For example, prod-abcdzk7xy33qa.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne."
}

list_stack_instances_for_provisioned_product

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific AWS account name or region.

Parameters

$body

Type: object

{
"PageSize" : "The maximum number of items to return with this call.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null.",
"ProvisionedProductId" : "The identifier of the provisioned product."
}

list_tag_options

Lists the specified TagOptions or all TagOptions.

Parameters

$body

Type: object

{
"Filters" : {
"Active" : "The active state.",
"Value" : "The TagOption value.",
"Key" : "The TagOption key."
}
}

provision_product

Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Parameters

$body

Type: object

{
"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 ListLaunchPaths.",
"ProvisioningParameters" : [ {
"Value" : "The parameter value.",
"Key" : "The parameter key."
} ],
"ProvisioningPreferences" : {
"StackSetAccounts" : [ "string" ],
"StackSetFailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. \nThe default value is 0 if no value is specified.",
"StackSetMaxConcurrencyPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.",
"StackSetMaxConcurrencyCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.",
"StackSetRegions" : [ "string" ],
"StackSetFailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both."
},
"NotificationArns" : [ "string" ],
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"ProvisionToken" : "An idempotency token that uniquely identifies the provisioning request.",
"Tags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"ProvisioningArtifactId" : "The identifier of the provisioning artifact.",
"ProvisionedProductName" : "A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned."
}

reject_portfolio_share

Rejects an offer to share the specified portfolio.

Parameters

$body

Type: object

{
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"PortfolioShareType" : "The type of shared portfolios to reject. The default is to reject imported portfolios. \n AWS_ORGANIZATIONS - Reject portfolios shared by the master account of your organization. \n IMPORTED - Reject imported portfolios. \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) \nFor example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS "
}

scan_provisioned_products

Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.

Parameters

$body

Type: object

{
"AccessLevelFilter" : {
"Value" : "The user to which the access level applies. The only supported value is Self.",
"Key" : "The access level. \n Account - Filter results based on the account. \n Role - Filter results based on the federated role of the specified user. \n User - Filter results based on the specified user. "
},
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese "
}

search_products

Gets information about the products to which the caller has access.

Parameters

$body

Type: object

{
"Filters" : "The search filters. If no search filters are specified, the output includes all products to which the caller has access.",
"PageSize" : "The maximum number of items to return with this call.",
"SortBy" : "The sort field. If no value is specified, the results are not sorted.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SortOrder" : "The sort order. If no value is specified, the results are not sorted.",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null."
}

search_products_as_admin

Gets information about the products for the specified portfolio or all products.

Parameters

$body

Type: object

{
"ProductSource" : "Access level of the source of the product.",
"Filters" : "The search filters. If no search filters are specified, the output includes all products to which the administrator has access.",
"SortBy" : "The sort field. If no value is specified, the results are not sorted.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"PortfolioId" : "The portfolio identifier.",
"SortOrder" : "The sort order. If no value is specified, the results are not sorted."
}

search_provisioned_products

Gets information about the provisioned products that meet the specified criteria.

Parameters

$body

Type: object

{
"Filters" : "The search filters. \nWhen the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, and userArnSession. \nExample: \"SearchQuery\":[\"status:AVAILABLE\"] ",
"PageSize" : "The maximum number of items to return with this call.",
"AccessLevelFilter" : {
"Value" : "The user to which the access level applies. The only supported value is Self.",
"Key" : "The access level. \n Account - Filter results based on the account. \n Role - Filter results based on the federated role of the specified user. \n User - Filter results based on the specified user. "
},
"SortBy" : "The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SortOrder" : "The sort order. If no value is specified, the results are not sorted.",
"PageToken" : "The page token for the next set of results. To retrieve the first set of results, use null."
}

terminate_provisioned_product

Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.

Parameters

$body

Type: object

{
"IgnoreErrors" : "If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.",
"TerminateToken" : "An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProvisionedProductId" : "The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.",
"ProvisionedProductName" : "The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId."
}

update_constraint

Updates the specified constraint.

Parameters

$body

Type: object

{
"Description" : "The updated description of the constraint.",
"Parameters" : "The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH \nSpecify the RoleArn property as follows: \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"} \nYou cannot have both a LAUNCH and a STACKSET constraint. \nYou also cannot have more than one LAUNCH constraint on a product and portfolio. NOTIFICATION \nSpecify the NotificationArns property as follows: \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]} RESOURCE_UPDATE \nSpecify the TagUpdatesOnProvisionedProduct property as follows: \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}} \nThe TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED. STACKSET \nSpecify the Parameters property as follows: \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}} \nYou cannot have both a LAUNCH and a STACKSET constraint. \nYou also cannot have more than one STACKSET constraint on a product and portfolio. \nProducts with a STACKSET constraint will launch an AWS CloudFormation stack set. TEMPLATE \nSpecify the Rules property. For more information, see Template Constraint Rules.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The identifier of the constraint."
}

update_portfolio

Updates the specified portfolio.
You cannot update a product that was shared with you.

Parameters

$body

Type: object

{
"ProviderName" : "The updated name of the portfolio provider.",
"RemoveTags" : [ "string" ],
"Description" : "The updated description of the portfolio.",
"DisplayName" : "The name to use for display purposes.",
"AddTags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The portfolio identifier."
}

update_product

Updates the specified product.

Parameters

$body

Type: object

{
"RemoveTags" : [ "string" ],
"Owner" : "The updated owner of the product.",
"SupportDescription" : "The updated support description for the product.",
"Description" : "The updated description of the product.",
"Distributor" : "The updated distributor of the product.",
"SupportEmail" : "The updated support email for the product.",
"AddTags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"SupportUrl" : "The updated support URL for the product.",
"Id" : "The product identifier.",
"Name" : "The updated product name."
}

update_provisioned_product

Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.

Parameters

$body

Type: object

{
"PathId" : "The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.",
"ProvisioningParameters" : [ {
"UsePreviousValue" : "If set to true, Value is ignored and the previous parameter value is kept.",
"Value" : "The parameter value.",
"Key" : "The parameter key."
} ],
"ProvisioningPreferences" : {
"StackSetAccounts" : [ "string" ],
"StackSetFailureToleranceCount" : "The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. \nThe default value is 0 if no value is specified.",
"StackSetMaxConcurrencyPercentage" : "The maximum percentage of accounts in which to perform this operation at one time. \nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.",
"StackSetMaxConcurrencyCount" : "The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount. \nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.",
"StackSetRegions" : [ "string" ],
"StackSetOperationType" : "Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified. \nApplicable only to a CFN_STACKSET provisioned product type. CREATE \nCreates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored. UPDATE \nUpdates the stack set represented by the provisioned product and also its stack instances. DELETE \nDeletes a stack instance in the stack set represented by the provisioned product.",
"StackSetFailureTolerancePercentage" : "The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. \nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. \nApplicable only to a CFN_STACKSET provisioned product type. \nConditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both."
},
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProvisionedProductId" : "The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.",
"ProductId" : "The identifier of the product.",
"Tags" : [ {
"Value" : "The value for this key.",
"Key" : "The tag key."
} ],
"UpdateToken" : "The idempotency token that uniquely identifies the provisioning update request.",
"ProvisionedProductName" : "The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact."
}

update_provisioned_product_properties

Requests updates to the properties of the specified provisioned product.

Parameters

$body

Type: object

{
"IdempotencyToken" : "The idempotency token that uniquely identifies the provisioning product update request.",
"ProvisionedProductProperties" : "A map that contains the provisioned product properties to be updated. \nThe OWNER key only accepts user ARNs. The owner is the user that is allowed to see, update, terminate, and execute service actions in the provisioned product. \nThe administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product's history from when he was an owner using ListRecordHistory. \nIf a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProvisionedProductId" : "The identifier of the provisioned product."
}

update_provisioning_artifact

Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.

Parameters

$body

Type: object

{
"Guidance" : "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use. \nThe DEFAULT value indicates that the product version is active. \nThe administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.",
"Active" : "Indicates whether the product version is active.",
"Description" : "The updated description of the provisioning artifact.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"ProductId" : "The product identifier.",
"ProvisioningArtifactId" : "The identifier of the provisioning artifact.",
"Name" : "The updated name of the provisioning artifact."
}

update_service_action

Updates a self-service action.

Parameters

$body

Type: object

{
"Description" : "The self-service action description.",
"Definition" : "A map that defines the self-service action.",
"AcceptLanguage" : "The language code. \n en - English (default) \n jp - Japanese \n zh - Chinese ",
"Id" : "The self-service action identifier.",
"Name" : "The self-service action name."
}

update_tag_option

Updates the specified TagOption.

Parameters

$body

Type: object

{
"Active" : "The updated active state.",
"Value" : "The updated value.",
"Id" : "The TagOption identifier."
}