AcceptPortfolioShare

$result = $client->acceptPortfolioShare([/* ... */]);
$promise = $client->acceptPortfolioShareAsync([/* ... */]);

Accepts an offer to share the specified portfolio.

Parameter Syntax

$result = $client->acceptPortfolioShare([
    'AcceptLanguage' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'PortfolioShareType' => 'IMPORTED|AWS_SERVICECATALOG|AWS_ORGANIZATIONS',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

AssociateBudgetWithResource

$result = $client->associateBudgetWithResource([/* ... */]);
$promise = $client->associateBudgetWithResourceAsync([/* ... */]);

Associates the specified budget with the specified resource.

Parameter Syntax

$result = $client->associateBudgetWithResource([
    'BudgetName' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DuplicateResourceException:

The specified resource is a duplicate.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

ResourceNotFoundException:

The specified resource was not found.

AssociatePrincipalWithPortfolio

$result = $client->associatePrincipalWithPortfolio([/* ... */]);
$promise = $client->associatePrincipalWithPortfolioAsync([/* ... */]);

Associates the specified principal ARN with the specified portfolio.

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.

The PortfolioID, PrincipalARN, and PrincipalType parameters are required.

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN.

Parameter Syntax

$result = $client->associatePrincipalWithPortfolio([
    'AcceptLanguage' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'PrincipalARN' => '<string>', // REQUIRED
    'PrincipalType' => 'IAM|IAM_PATTERN', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

AssociateProductWithPortfolio

$result = $client->associateProductWithPortfolio([/* ... */]);
$promise = $client->associateProductWithPortfolioAsync([/* ... */]);

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->associateProductWithPortfolio([
    'AcceptLanguage' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'SourcePortfolioId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

AssociateServiceActionWithProvisioningArtifact

$result = $client->associateServiceActionWithProvisioningArtifact([/* ... */]);
$promise = $client->associateServiceActionWithProvisioningArtifactAsync([/* ... */]);

Associates a self-service action with a provisioning artifact.

Parameter Syntax

$result = $client->associateServiceActionWithProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'ProvisioningArtifactId' => '<string>', // REQUIRED
    'ServiceActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DuplicateResourceException:

The specified resource is a duplicate.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

AssociateTagOptionWithResource

$result = $client->associateTagOptionWithResource([/* ... */]);
$promise = $client->associateTagOptionWithResourceAsync([/* ... */]);

Associate the specified TagOption with the specified portfolio or product.

Parameter Syntax

$result = $client->associateTagOptionWithResource([
    'ResourceId' => '<string>', // REQUIRED
    'TagOptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

DuplicateResourceException:

The specified resource is a duplicate.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

BatchAssociateServiceActionWithProvisioningArtifact

$result = $client->batchAssociateServiceActionWithProvisioningArtifact([/* ... */]);
$promise = $client->batchAssociateServiceActionWithProvisioningArtifactAsync([/* ... */]);

Associates multiple self-service actions with provisioning artifacts.

Parameter Syntax

$result = $client->batchAssociateServiceActionWithProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'ServiceActionAssociations' => [ // REQUIRED
        [
            'ProductId' => '<string>', // REQUIRED
            'ProvisioningArtifactId' => '<string>', // REQUIRED
            'ServiceActionId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedServiceActionAssociations' => [
        [
            'ErrorCode' => 'DUPLICATE_RESOURCE|INTERNAL_FAILURE|LIMIT_EXCEEDED|RESOURCE_NOT_FOUND|THROTTLING|INVALID_PARAMETER',
            'ErrorMessage' => '<string>',
            'ProductId' => '<string>',
            'ProvisioningArtifactId' => '<string>',
            'ServiceActionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

BatchDisassociateServiceActionFromProvisioningArtifact

$result = $client->batchDisassociateServiceActionFromProvisioningArtifact([/* ... */]);
$promise = $client->batchDisassociateServiceActionFromProvisioningArtifactAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDisassociateServiceActionFromProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'ServiceActionAssociations' => [ // REQUIRED
        [
            'ProductId' => '<string>', // REQUIRED
            'ProvisioningArtifactId' => '<string>', // REQUIRED
            'ServiceActionId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FailedServiceActionAssociations' => [
        [
            'ErrorCode' => 'DUPLICATE_RESOURCE|INTERNAL_FAILURE|LIMIT_EXCEEDED|RESOURCE_NOT_FOUND|THROTTLING|INVALID_PARAMETER',
            'ErrorMessage' => '<string>',
            'ProductId' => '<string>',
            'ProvisioningArtifactId' => '<string>',
            'ServiceActionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

CopyProduct

$result = $client->copyProduct([/* ... */]);
$promise = $client->copyProductAsync([/* ... */]);

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. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Parameter Syntax

$result = $client->copyProduct([
    'AcceptLanguage' => '<string>',
    'CopyOptions' => ['<string>', ...],
    'IdempotencyToken' => '<string>', // REQUIRED
    'SourceProductArn' => '<string>', // REQUIRED
    'SourceProvisioningArtifactIdentifiers' => [
        ['<string>', ...],
        // ...
    ],
    'TargetProductId' => '<string>',
    'TargetProductName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CopyProductToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

CreateConstraint

$result = $client->createConstraint([/* ... */]);
$promise = $client->createConstraintAsync([/* ... */]);

Creates a constraint.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->createConstraint([
    'AcceptLanguage' => '<string>',
    'Description' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'Parameters' => '<string>', // REQUIRED
    'PortfolioId' => '<string>', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'Type' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConstraintDetail' => [
        'ConstraintId' => '<string>',
        'Description' => '<string>',
        'Owner' => '<string>',
        'PortfolioId' => '<string>',
        'ProductId' => '<string>',
        'Type' => '<string>',
    ],
    'ConstraintParameters' => '<string>',
    'Status' => 'AVAILABLE|CREATING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

DuplicateResourceException:

The specified resource is a duplicate.

CreatePortfolio

$result = $client->createPortfolio([/* ... */]);
$promise = $client->createPortfolioAsync([/* ... */]);

Creates a portfolio.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->createPortfolio([
    'AcceptLanguage' => '<string>',
    'Description' => '<string>',
    'DisplayName' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>', // REQUIRED
    'ProviderName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'PortfolioDetail' => [
        'ARN' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Id' => '<string>',
        'ProviderName' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

CreatePortfolioShare

$result = $client->createPortfolioShare([/* ... */]);
$promise = $client->createPortfolioShareAsync([/* ... */]);

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

Parameter Syntax

$result = $client->createPortfolioShare([
    'AcceptLanguage' => '<string>',
    'AccountId' => '<string>',
    'OrganizationNode' => [
        'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
        'Value' => '<string>',
    ],
    'PortfolioId' => '<string>', // REQUIRED
    'SharePrincipals' => true || false,
    'ShareTagOptions' => true || false,
]);

Parameter Details

Result Syntax

[
    'PortfolioShareToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

OperationNotSupportedException:

The operation is not supported.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

CreateProduct

$result = $client->createProduct([/* ... */]);
$promise = $client->createProductAsync([/* ... */]);

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Parameter Syntax

$result = $client->createProduct([
    'AcceptLanguage' => '<string>',
    'Description' => '<string>',
    'Distributor' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Owner' => '<string>', // REQUIRED
    'ProductType' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL', // REQUIRED
    'ProvisioningArtifactParameters' => [
        'Description' => '<string>',
        'DisableTemplateValidation' => true || false,
        'Info' => ['<string>', ...],
        'Name' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'SourceConnection' => [
        'ConnectionParameters' => [ // REQUIRED
            'CodeStar' => [
                'ArtifactPath' => '<string>', // REQUIRED
                'Branch' => '<string>', // REQUIRED
                'ConnectionArn' => '<string>', // REQUIRED
                'Repository' => '<string>', // REQUIRED
            ],
        ],
        'Type' => 'CODESTAR',
    ],
    'SupportDescription' => '<string>',
    'SupportEmail' => '<string>',
    'SupportUrl' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ProductViewDetail' => [
        'CreatedTime' => <DateTime>,
        'ProductARN' => '<string>',
        'ProductViewSummary' => [
            'Distributor' => '<string>',
            'HasDefaultPath' => true || false,
            'Id' => '<string>',
            'Name' => '<string>',
            'Owner' => '<string>',
            'ProductId' => '<string>',
            'ShortDescription' => '<string>',
            'SupportDescription' => '<string>',
            'SupportEmail' => '<string>',
            'SupportUrl' => '<string>',
            'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
        ],
        'SourceConnection' => [
            'ConnectionParameters' => [
                'CodeStar' => [
                    'ArtifactPath' => '<string>',
                    'Branch' => '<string>',
                    'ConnectionArn' => '<string>',
                    'Repository' => '<string>',
                ],
            ],
            'LastSync' => [
                'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
                'LastSuccessfulSyncTime' => <DateTime>,
                'LastSyncStatus' => 'SUCCEEDED|FAILED',
                'LastSyncStatusMessage' => '<string>',
                'LastSyncTime' => <DateTime>,
            ],
            'Type' => 'CODESTAR',
        ],
        'Status' => 'AVAILABLE|CREATING|FAILED',
    ],
    'ProvisioningArtifactDetail' => [
        'Active' => true || false,
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'Guidance' => 'DEFAULT|DEPRECATED',
        'Id' => '<string>',
        'Name' => '<string>',
        'SourceRevision' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

CreateProvisionedProductPlan

$result = $client->createProvisionedProductPlan([/* ... */]);
$promise = $client->createProvisionedProductPlanAsync([/* ... */]);

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 for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Parameter Syntax

$result = $client->createProvisionedProductPlan([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'NotificationArns' => ['<string>', ...],
    'PathId' => '<string>',
    'PlanName' => '<string>', // REQUIRED
    'PlanType' => 'CLOUDFORMATION', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'ProvisionedProductName' => '<string>', // REQUIRED
    'ProvisioningArtifactId' => '<string>', // REQUIRED
    'ProvisioningParameters' => [
        [
            'Key' => '<string>',
            'UsePreviousValue' => true || false,
            'Value' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'PlanId' => '<string>',
    'PlanName' => '<string>',
    'ProvisionProductId' => '<string>',
    'ProvisionedProductName' => '<string>',
    'ProvisioningArtifactId' => '<string>',
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

CreateProvisioningArtifact

$result = $client->createProvisioningArtifact([/* ... */]);
$promise = $client->createProvisioningArtifactAsync([/* ... */]);

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.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Parameter Syntax

$result = $client->createProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'Parameters' => [ // REQUIRED
        'Description' => '<string>',
        'DisableTemplateValidation' => true || false,
        'Info' => ['<string>', ...],
        'Name' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Info' => ['<string>', ...],
    'ProvisioningArtifactDetail' => [
        'Active' => true || false,
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'Guidance' => 'DEFAULT|DEPRECATED',
        'Id' => '<string>',
        'Name' => '<string>',
        'SourceRevision' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'Status' => 'AVAILABLE|CREATING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

CreateServiceAction

$result = $client->createServiceAction([/* ... */]);
$promise = $client->createServiceActionAsync([/* ... */]);

Creates a self-service action.

Parameter Syntax

$result = $client->createServiceAction([
    'AcceptLanguage' => '<string>',
    'Definition' => ['<string>', ...], // REQUIRED
    'DefinitionType' => 'SSM_AUTOMATION', // REQUIRED
    'Description' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServiceActionDetail' => [
        'Definition' => ['<string>', ...],
        'ServiceActionSummary' => [
            'DefinitionType' => 'SSM_AUTOMATION',
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

CreateTagOption

$result = $client->createTagOption([/* ... */]);
$promise = $client->createTagOptionAsync([/* ... */]);

Creates a TagOption.

Parameter Syntax

$result = $client->createTagOption([
    'Key' => '<string>', // REQUIRED
    'Value' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagOptionDetail' => [
        'Active' => true || false,
        'Id' => '<string>',
        'Key' => '<string>',
        'Owner' => '<string>',
        'Value' => '<string>',
    ],
]

Result Details

Errors

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

DuplicateResourceException:

The specified resource is a duplicate.

LimitExceededException:

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

DeleteConstraint

$result = $client->deleteConstraint([/* ... */]);
$promise = $client->deleteConstraintAsync([/* ... */]);

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->deleteConstraint([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DeletePortfolio

$result = $client->deletePortfolio([/* ... */]);
$promise = $client->deletePortfolioAsync([/* ... */]);

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.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->deletePortfolio([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

DeletePortfolioShare

$result = $client->deletePortfolioShare([/* ... */]);
$promise = $client->deletePortfolioShareAsync([/* ... */]);

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

Parameter Syntax

$result = $client->deletePortfolioShare([
    'AcceptLanguage' => '<string>',
    'AccountId' => '<string>',
    'OrganizationNode' => [
        'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
        'Value' => '<string>',
    ],
    'PortfolioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PortfolioShareToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

OperationNotSupportedException:

The operation is not supported.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

DeleteProduct

$result = $client->deleteProduct([/* ... */]);
$promise = $client->deleteProductAsync([/* ... */]);

Deletes the specified product.

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

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->deleteProduct([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

DeleteProvisionedProductPlan

$result = $client->deleteProvisionedProductPlan([/* ... */]);
$promise = $client->deleteProvisionedProductPlanAsync([/* ... */]);

Deletes the specified plan.

Parameter Syntax

$result = $client->deleteProvisionedProductPlan([
    'AcceptLanguage' => '<string>',
    'IgnoreErrors' => true || false,
    'PlanId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

DeleteProvisioningArtifact

$result = $client->deleteProvisioningArtifact([/* ... */]);
$promise = $client->deleteProvisioningArtifactAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'ProvisioningArtifactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DeleteServiceAction

$result = $client->deleteServiceAction([/* ... */]);
$promise = $client->deleteServiceActionAsync([/* ... */]);

Deletes a self-service action.

Parameter Syntax

$result = $client->deleteServiceAction([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DeleteTagOption

$result = $client->deleteTagOption([/* ... */]);
$promise = $client->deleteTagOptionAsync([/* ... */]);

Deletes the specified TagOption.

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

Parameter Syntax

$result = $client->deleteTagOption([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

ResourceNotFoundException:

The specified resource was not found.

DescribeConstraint

$result = $client->describeConstraint([/* ... */]);
$promise = $client->describeConstraintAsync([/* ... */]);

Gets information about the specified constraint.

Parameter Syntax

$result = $client->describeConstraint([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConstraintDetail' => [
        'ConstraintId' => '<string>',
        'Description' => '<string>',
        'Owner' => '<string>',
        'PortfolioId' => '<string>',
        'ProductId' => '<string>',
        'Type' => '<string>',
    ],
    'ConstraintParameters' => '<string>',
    'Status' => 'AVAILABLE|CREATING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeCopyProductStatus

$result = $client->describeCopyProductStatus([/* ... */]);
$promise = $client->describeCopyProductStatusAsync([/* ... */]);

Gets the status of the specified copy product operation.

Parameter Syntax

$result = $client->describeCopyProductStatus([
    'AcceptLanguage' => '<string>',
    'CopyProductToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CopyProductStatus' => 'SUCCEEDED|IN_PROGRESS|FAILED',
    'StatusDetail' => '<string>',
    'TargetProductId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribePortfolio

$result = $client->describePortfolio([/* ... */]);
$promise = $client->describePortfolioAsync([/* ... */]);

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->describePortfolio([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Budgets' => [
        [
            'BudgetName' => '<string>',
        ],
        // ...
    ],
    'PortfolioDetail' => [
        'ARN' => '<string>',
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'Id' => '<string>',
        'ProviderName' => '<string>',
    ],
    'TagOptions' => [
        [
            'Active' => true || false,
            'Id' => '<string>',
            'Key' => '<string>',
            'Owner' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribePortfolioShareStatus

$result = $client->describePortfolioShareStatus([/* ... */]);
$promise = $client->describePortfolioShareStatusAsync([/* ... */]);

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Parameter Syntax

$result = $client->describePortfolioShareStatus([
    'PortfolioShareToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OrganizationNodeValue' => '<string>',
    'PortfolioId' => '<string>',
    'PortfolioShareToken' => '<string>',
    'ShareDetails' => [
        'ShareErrors' => [
            [
                'Accounts' => ['<string>', ...],
                'Error' => '<string>',
                'Message' => '<string>',
            ],
            // ...
        ],
        'SuccessfulShares' => ['<string>', ...],
    ],
    'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|ERROR',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

OperationNotSupportedException:

The operation is not supported.

DescribePortfolioShares

$result = $client->describePortfolioShares([/* ... */]);
$promise = $client->describePortfolioSharesAsync([/* ... */]);

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

Parameter Syntax

$result = $client->describePortfolioShares([
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATIONAL_UNIT|ORGANIZATION_MEMBER_ACCOUNT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'PortfolioShareDetails' => [
        [
            'Accepted' => true || false,
            'PrincipalId' => '<string>',
            'SharePrincipals' => true || false,
            'ShareTagOptions' => true || false,
            'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATIONAL_UNIT|ORGANIZATION_MEMBER_ACCOUNT',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProduct

$result = $client->describeProduct([/* ... */]);
$promise = $client->describeProductAsync([/* ... */]);

Gets information about the specified product.

Parameter Syntax

$result = $client->describeProduct([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Budgets' => [
        [
            'BudgetName' => '<string>',
        ],
        // ...
    ],
    'LaunchPaths' => [
        [
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'ProductViewSummary' => [
        'Distributor' => '<string>',
        'HasDefaultPath' => true || false,
        'Id' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'ProductId' => '<string>',
        'ShortDescription' => '<string>',
        'SupportDescription' => '<string>',
        'SupportEmail' => '<string>',
        'SupportUrl' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'ProvisioningArtifacts' => [
        [
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Guidance' => 'DEFAULT|DEPRECATED',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProductAsAdmin

$result = $client->describeProductAsAdmin([/* ... */]);
$promise = $client->describeProductAsAdminAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeProductAsAdmin([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'SourcePortfolioId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Budgets' => [
        [
            'BudgetName' => '<string>',
        ],
        // ...
    ],
    'ProductViewDetail' => [
        'CreatedTime' => <DateTime>,
        'ProductARN' => '<string>',
        'ProductViewSummary' => [
            'Distributor' => '<string>',
            'HasDefaultPath' => true || false,
            'Id' => '<string>',
            'Name' => '<string>',
            'Owner' => '<string>',
            'ProductId' => '<string>',
            'ShortDescription' => '<string>',
            'SupportDescription' => '<string>',
            'SupportEmail' => '<string>',
            'SupportUrl' => '<string>',
            'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
        ],
        'SourceConnection' => [
            'ConnectionParameters' => [
                'CodeStar' => [
                    'ArtifactPath' => '<string>',
                    'Branch' => '<string>',
                    'ConnectionArn' => '<string>',
                    'Repository' => '<string>',
                ],
            ],
            'LastSync' => [
                'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
                'LastSuccessfulSyncTime' => <DateTime>,
                'LastSyncStatus' => 'SUCCEEDED|FAILED',
                'LastSyncStatusMessage' => '<string>',
                'LastSyncTime' => <DateTime>,
            ],
            'Type' => 'CODESTAR',
        ],
        'Status' => 'AVAILABLE|CREATING|FAILED',
    ],
    'ProvisioningArtifactSummaries' => [
        [
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'ProvisioningArtifactMetadata' => ['<string>', ...],
        ],
        // ...
    ],
    'TagOptions' => [
        [
            'Active' => true || false,
            'Id' => '<string>',
            'Key' => '<string>',
            'Owner' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProductView

$result = $client->describeProductView([/* ... */]);
$promise = $client->describeProductViewAsync([/* ... */]);

Gets information about the specified product.

Parameter Syntax

$result = $client->describeProductView([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProductViewSummary' => [
        'Distributor' => '<string>',
        'HasDefaultPath' => true || false,
        'Id' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'ProductId' => '<string>',
        'ShortDescription' => '<string>',
        'SupportDescription' => '<string>',
        'SupportEmail' => '<string>',
        'SupportUrl' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'ProvisioningArtifacts' => [
        [
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Guidance' => 'DEFAULT|DEPRECATED',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProvisionedProduct

$result = $client->describeProvisionedProduct([/* ... */]);
$promise = $client->describeProvisionedProductAsync([/* ... */]);

Gets information about the specified provisioned product.

Parameter Syntax

$result = $client->describeProvisionedProduct([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CloudWatchDashboards' => [
        [
            'Name' => '<string>',
        ],
        // ...
    ],
    'ProvisionedProductDetail' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'IdempotencyToken' => '<string>',
        'LastProvisioningRecordId' => '<string>',
        'LastRecordId' => '<string>',
        'LastSuccessfulProvisioningRecordId' => '<string>',
        'LaunchRoleArn' => '<string>',
        'Name' => '<string>',
        'ProductId' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'Status' => 'AVAILABLE|UNDER_CHANGE|TAINTED|ERROR|PLAN_IN_PROGRESS',
        'StatusMessage' => '<string>',
        'Type' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProvisionedProductPlan

$result = $client->describeProvisionedProductPlan([/* ... */]);
$promise = $client->describeProvisionedProductPlanAsync([/* ... */]);

Gets information about the resource changes for the specified plan.

Parameter Syntax

$result = $client->describeProvisionedProductPlan([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PlanId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'ProvisionedProductPlanDetails' => [
        'CreatedTime' => <DateTime>,
        'NotificationArns' => ['<string>', ...],
        'PathId' => '<string>',
        'PlanId' => '<string>',
        'PlanName' => '<string>',
        'PlanType' => 'CLOUDFORMATION',
        'ProductId' => '<string>',
        'ProvisionProductId' => '<string>',
        'ProvisionProductName' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'ProvisioningParameters' => [
            [
                'Key' => '<string>',
                'UsePreviousValue' => true || false,
                'Value' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATE_IN_PROGRESS|CREATE_SUCCESS|CREATE_FAILED|EXECUTE_IN_PROGRESS|EXECUTE_SUCCESS|EXECUTE_FAILED',
        'StatusMessage' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedTime' => <DateTime>,
    ],
    'ResourceChanges' => [
        [
            'Action' => 'ADD|MODIFY|REMOVE',
            'Details' => [
                [
                    'CausingEntity' => '<string>',
                    'Evaluation' => 'STATIC|DYNAMIC',
                    'Target' => [
                        'Attribute' => 'PROPERTIES|METADATA|CREATIONPOLICY|UPDATEPOLICY|DELETIONPOLICY|TAGS',
                        'Name' => '<string>',
                        'RequiresRecreation' => 'NEVER|CONDITIONALLY|ALWAYS',
                    ],
                ],
                // ...
            ],
            'LogicalResourceId' => '<string>',
            'PhysicalResourceId' => '<string>',
            'Replacement' => 'TRUE|FALSE|CONDITIONAL',
            'ResourceType' => '<string>',
            'Scope' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProvisioningArtifact

$result = $client->describeProvisioningArtifact([/* ... */]);
$promise = $client->describeProvisioningArtifactAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'IncludeProvisioningArtifactParameters' => true || false,
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'ProvisioningArtifactId' => '<string>',
    'ProvisioningArtifactName' => '<string>',
    'Verbose' => true || false,
]);

Parameter Details

Result Syntax

[
    'Info' => ['<string>', ...],
    'ProvisioningArtifactDetail' => [
        'Active' => true || false,
        'CreatedTime' => <DateTime>,
        'Description' => '<string>',
        'Guidance' => 'DEFAULT|DEPRECATED',
        'Id' => '<string>',
        'Name' => '<string>',
        'SourceRevision' => '<string>',
        'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
    ],
    'ProvisioningArtifactParameters' => [
        [
            'DefaultValue' => '<string>',
            'Description' => '<string>',
            'IsNoEcho' => true || false,
            'ParameterConstraints' => [
                'AllowedPattern' => '<string>',
                'AllowedValues' => ['<string>', ...],
                'ConstraintDescription' => '<string>',
                'MaxLength' => '<string>',
                'MaxValue' => '<string>',
                'MinLength' => '<string>',
                'MinValue' => '<string>',
            ],
            'ParameterKey' => '<string>',
            'ParameterType' => '<string>',
        ],
        // ...
    ],
    'Status' => 'AVAILABLE|CREATING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DescribeProvisioningParameters

$result = $client->describeProvisioningParameters([/* ... */]);
$promise = $client->describeProvisioningParametersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeProvisioningParameters([
    'AcceptLanguage' => '<string>',
    'PathId' => '<string>',
    'PathName' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'ProvisioningArtifactId' => '<string>',
    'ProvisioningArtifactName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ConstraintSummaries' => [
        [
            'Description' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'ProvisioningArtifactOutputKeys' => [
        [
            'Description' => '<string>',
            'Key' => '<string>',
        ],
        // ...
    ],
    'ProvisioningArtifactOutputs' => [
        [
            'Description' => '<string>',
            'Key' => '<string>',
        ],
        // ...
    ],
    'ProvisioningArtifactParameters' => [
        [
            'DefaultValue' => '<string>',
            'Description' => '<string>',
            'IsNoEcho' => true || false,
            'ParameterConstraints' => [
                'AllowedPattern' => '<string>',
                'AllowedValues' => ['<string>', ...],
                'ConstraintDescription' => '<string>',
                'MaxLength' => '<string>',
                'MaxValue' => '<string>',
                'MinLength' => '<string>',
                'MinValue' => '<string>',
            ],
            'ParameterKey' => '<string>',
            'ParameterType' => '<string>',
        ],
        // ...
    ],
    'ProvisioningArtifactPreferences' => [
        'StackSetAccounts' => ['<string>', ...],
        'StackSetRegions' => ['<string>', ...],
    ],
    'TagOptions' => [
        [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'UsageInstructions' => [
        [
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

DescribeRecord

$result = $client->describeRecord([/* ... */]);
$promise = $client->describeRecordAsync([/* ... */]);

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Parameter Syntax

$result = $client->describeRecord([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
    'PageSize' => <integer>,
    'PageToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'RecordDetail' => [
        'CreatedTime' => <DateTime>,
        'LaunchRoleArn' => '<string>',
        'PathId' => '<string>',
        'ProductId' => '<string>',
        'ProvisionedProductId' => '<string>',
        'ProvisionedProductName' => '<string>',
        'ProvisionedProductType' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'RecordErrors' => [
            [
                'Code' => '<string>',
                'Description' => '<string>',
            ],
            // ...
        ],
        'RecordId' => '<string>',
        'RecordTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordType' => '<string>',
        'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
        'UpdatedTime' => <DateTime>,
    ],
    'RecordOutputs' => [
        [
            'Description' => '<string>',
            'OutputKey' => '<string>',
            'OutputValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeServiceAction

$result = $client->describeServiceAction([/* ... */]);
$promise = $client->describeServiceActionAsync([/* ... */]);

Describes a self-service action.

Parameter Syntax

$result = $client->describeServiceAction([
    'AcceptLanguage' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServiceActionDetail' => [
        'Definition' => ['<string>', ...],
        'ServiceActionSummary' => [
            'DefinitionType' => 'SSM_AUTOMATION',
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DescribeServiceActionExecutionParameters

$result = $client->describeServiceActionExecutionParameters([/* ... */]);
$promise = $client->describeServiceActionExecutionParametersAsync([/* ... */]);

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

Parameter Syntax

$result = $client->describeServiceActionExecutionParameters([
    'AcceptLanguage' => '<string>',
    'ProvisionedProductId' => '<string>', // REQUIRED
    'ServiceActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServiceActionParameters' => [
        [
            'DefaultValues' => ['<string>', ...],
            'Name' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

DescribeTagOption

$result = $client->describeTagOption([/* ... */]);
$promise = $client->describeTagOptionAsync([/* ... */]);

Gets information about the specified TagOption.

Parameter Syntax

$result = $client->describeTagOption([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagOptionDetail' => [
        'Active' => true || false,
        'Id' => '<string>',
        'Key' => '<string>',
        'Owner' => '<string>',
        'Value' => '<string>',
    ],
]

Result Details

Errors

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

ResourceNotFoundException:

The specified resource was not found.

DisableAWSOrganizationsAccess

$result = $client->disableAWSOrganizationsAccess([/* ... */]);
$promise = $client->disableAWSOrganizationsAccessAsync([/* ... */]);

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

You cannot call this API if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

Parameter Syntax

$result = $client->disableAWSOrganizationsAccess([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

OperationNotSupportedException:

The operation is not supported.

DisassociateBudgetFromResource

$result = $client->disassociateBudgetFromResource([/* ... */]);
$promise = $client->disassociateBudgetFromResourceAsync([/* ... */]);

Disassociates the specified budget from the specified resource.

Parameter Syntax

$result = $client->disassociateBudgetFromResource([
    'BudgetName' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

DisassociatePrincipalFromPortfolio

$result = $client->disassociatePrincipalFromPortfolio([/* ... */]);
$promise = $client->disassociatePrincipalFromPortfolioAsync([/* ... */]);

Disassociates a previously associated principal ARN from a specified portfolio.

The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

Parameter Syntax

$result = $client->disassociatePrincipalFromPortfolio([
    'AcceptLanguage' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'PrincipalARN' => '<string>', // REQUIRED
    'PrincipalType' => 'IAM|IAM_PATTERN',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

DisassociateProductFromPortfolio

$result = $client->disassociateProductFromPortfolio([/* ... */]);
$promise = $client->disassociateProductFromPortfolioAsync([/* ... */]);

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

Parameter Syntax

$result = $client->disassociateProductFromPortfolio([
    'AcceptLanguage' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

ResourceInUseException:

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DisassociateServiceActionFromProvisioningArtifact

$result = $client->disassociateServiceActionFromProvisioningArtifact([/* ... */]);
$promise = $client->disassociateServiceActionFromProvisioningArtifactAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateServiceActionFromProvisioningArtifact([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'ProvisioningArtifactId' => '<string>', // REQUIRED
    'ServiceActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

DisassociateTagOptionFromResource

$result = $client->disassociateTagOptionFromResource([/* ... */]);
$promise = $client->disassociateTagOptionFromResourceAsync([/* ... */]);

Disassociates the specified TagOption from the specified resource.

Parameter Syntax

$result = $client->disassociateTagOptionFromResource([
    'ResourceId' => '<string>', // REQUIRED
    'TagOptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TagOptionNotMigratedException:

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

ResourceNotFoundException:

The specified resource was not found.

EnableAWSOrganizationsAccess

$result = $client->enableAWSOrganizationsAccess([/* ... */]);
$promise = $client->enableAWSOrganizationsAccessAsync([/* ... */]);

Enable portfolio sharing feature through 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 management account in the organization.

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

Parameter Syntax

$result = $client->enableAWSOrganizationsAccess([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

OperationNotSupportedException:

The operation is not supported.

ExecuteProvisionedProductPlan

$result = $client->executeProvisionedProductPlan([/* ... */]);
$promise = $client->executeProvisionedProductPlanAsync([/* ... */]);

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

Parameter Syntax

$result = $client->executeProvisionedProductPlan([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'PlanId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecordDetail' => [
        'CreatedTime' => <DateTime>,
        'LaunchRoleArn' => '<string>',
        'PathId' => '<string>',
        'ProductId' => '<string>',
        'ProvisionedProductId' => '<string>',
        'ProvisionedProductName' => '<string>',
        'ProvisionedProductType' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'RecordErrors' => [
            [
                'Code' => '<string>',
                'Description' => '<string>',
            ],
            // ...
        ],
        'RecordId' => '<string>',
        'RecordTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordType' => '<string>',
        'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
        'UpdatedTime' => <DateTime>,
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

ExecuteProvisionedProductServiceAction

$result = $client->executeProvisionedProductServiceAction([/* ... */]);
$promise = $client->executeProvisionedProductServiceActionAsync([/* ... */]);

Executes a self-service action against a provisioned product.

Parameter Syntax

$result = $client->executeProvisionedProductServiceAction([
    'AcceptLanguage' => '<string>',
    'ExecuteToken' => '<string>', // REQUIRED
    'Parameters' => [
        '<ExecutionParameterKey>' => ['<string>', ...],
        // ...
    ],
    'ProvisionedProductId' => '<string>', // REQUIRED
    'ServiceActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecordDetail' => [
        'CreatedTime' => <DateTime>,
        'LaunchRoleArn' => '<string>',
        'PathId' => '<string>',
        'ProductId' => '<string>',
        'ProvisionedProductId' => '<string>',
        'ProvisionedProductName' => '<string>',
        'ProvisionedProductType' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'RecordErrors' => [
            [
                'Code' => '<string>',
                'Description' => '<string>',
            ],
            // ...
        ],
        'RecordId' => '<string>',
        'RecordTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordType' => '<string>',
        'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
        'UpdatedTime' => <DateTime>,
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

GetAWSOrganizationsAccessStatus

$result = $client->getAWSOrganizationsAccessStatus([/* ... */]);
$promise = $client->getAWSOrganizationsAccessStatusAsync([/* ... */]);

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

Parameter Syntax

$result = $client->getAWSOrganizationsAccessStatus([
]);

Parameter Details

Result Syntax

[
    'AccessStatus' => 'ENABLED|UNDER_CHANGE|DISABLED',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

OperationNotSupportedException:

The operation is not supported.

GetProvisionedProductOutputs

$result = $client->getProvisionedProductOutputs([/* ... */]);
$promise = $client->getProvisionedProductOutputsAsync([/* ... */]);

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

Parameter Syntax

$result = $client->getProvisionedProductOutputs([
    'AcceptLanguage' => '<string>',
    'OutputKeys' => ['<string>', ...],
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ProvisionedProductId' => '<string>',
    'ProvisionedProductName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'Outputs' => [
        [
            'Description' => '<string>',
            'OutputKey' => '<string>',
            'OutputValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

ImportAsProvisionedProduct

$result = $client->importAsProvisionedProduct([/* ... */]);
$promise = $client->importAsProvisionedProductAsync([/* ... */]);

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

You can only import one provisioned product at a time. The product's CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

Parameter Syntax

$result = $client->importAsProvisionedProduct([
    'AcceptLanguage' => '<string>',
    'IdempotencyToken' => '<string>', // REQUIRED
    'PhysicalId' => '<string>', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'ProvisionedProductName' => '<string>', // REQUIRED
    'ProvisioningArtifactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecordDetail' => [
        'CreatedTime' => <DateTime>,
        'LaunchRoleArn' => '<string>',
        'PathId' => '<string>',
        'ProductId' => '<string>',
        'ProvisionedProductId' => '<string>',
        'ProvisionedProductName' => '<string>',
        'ProvisionedProductType' => '<string>',
        'ProvisioningArtifactId' => '<string>',
        'RecordErrors' => [
            [
                'Code' => '<string>',
                'Description' => '<string>',
            ],
            // ...
        ],
        'RecordId' => '<string>',
        'RecordTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordType' => '<string>',
        'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
        'UpdatedTime' => <DateTime>,
    ],
]

Result Details

Errors

DuplicateResourceException:

The specified resource is a duplicate.

InvalidStateException:

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListAcceptedPortfolioShares

$result = $client->listAcceptedPortfolioShares([/* ... */]);
$promise = $client->listAcceptedPortfolioSharesAsync([/* ... */]);

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

Parameter Syntax

$result = $client->listAcceptedPortfolioShares([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioShareType' => 'IMPORTED|AWS_SERVICECATALOG|AWS_ORGANIZATIONS',
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'PortfolioDetails' => [
        [
            'ARN' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'Id' => '<string>',
            'ProviderName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

OperationNotSupportedException:

The operation is not supported.

ListBudgetsForResource

$result = $client->listBudgetsForResource([/* ... */]);
$promise = $client->listBudgetsForResourceAsync([/* ... */]);

Lists all the budgets associated to the specified resource.

Parameter Syntax

$result = $client->listBudgetsForResource([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Budgets' => [
        [
            'BudgetName' => '<string>',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListConstraintsForPortfolio

$result = $client->listConstraintsForPortfolio([/* ... */]);
$promise = $client->listConstraintsForPortfolioAsync([/* ... */]);

Lists the constraints for the specified portfolio and product.

Parameter Syntax

$result = $client->listConstraintsForPortfolio([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
    'ProductId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ConstraintDetails' => [
        [
            'ConstraintId' => '<string>',
            'Description' => '<string>',
            'Owner' => '<string>',
            'PortfolioId' => '<string>',
            'ProductId' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListLaunchPaths

$result = $client->listLaunchPaths([/* ... */]);
$promise = $client->listLaunchPathsAsync([/* ... */]);

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

Parameter Syntax

$result = $client->listLaunchPaths([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LaunchPathSummaries' => [
        [
            'ConstraintSummaries' => [
                [
                    'Description' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Id' => '<string>',
            'Name' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

ListOrganizationPortfolioAccess

$result = $client->listOrganizationPortfolioAccess([/* ... */]);
$promise = $client->listOrganizationPortfolioAccessAsync([/* ... */]);

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

Parameter Syntax

$result = $client->listOrganizationPortfolioAccess([
    'AcceptLanguage' => '<string>',
    'OrganizationNodeType' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT', // REQUIRED
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'OrganizationNodes' => [
        [
            'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

OperationNotSupportedException:

The operation is not supported.

ListPortfolioAccess

$result = $client->listPortfolioAccess([/* ... */]);
$promise = $client->listPortfolioAccessAsync([/* ... */]);

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

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

Parameter Syntax

$result = $client->listPortfolioAccess([
    'AcceptLanguage' => '<string>',
    'OrganizationParentId' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountIds' => ['<string>', ...],
    'NextPageToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListPortfolios

$result = $client->listPortfolios([/* ... */]);
$promise = $client->listPortfoliosAsync([/* ... */]);

Lists all portfolios in the catalog.

Parameter Syntax

$result = $client->listPortfolios([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'PortfolioDetails' => [
        [
            'ARN' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'Id' => '<string>',
            'ProviderName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListPortfoliosForProduct

$result = $client->listPortfoliosForProduct([/* ... */]);
$promise = $client->listPortfoliosForProductAsync([/* ... */]);

Lists all portfolios that the specified product is associated with.

Parameter Syntax

$result = $client->listPortfoliosForProduct([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'PortfolioDetails' => [
        [
            'ARN' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'Id' => '<string>',
            'ProviderName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ResourceNotFoundException:

The specified resource was not found.

ListPrincipalsForPortfolio

$result = $client->listPrincipalsForPortfolio([/* ... */]);
$promise = $client->listPrincipalsForPortfolioAsync([/* ... */]);

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

Parameter Syntax

$result = $client->listPrincipalsForPortfolio([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'PortfolioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'Principals' => [
        [
            'PrincipalARN' => '<string>',
            'PrincipalType' => 'IAM|IAM_PATTERN',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListProvisionedProductPlans

$result = $client->listProvisionedProductPlans([/* ... */]);
$promise = $client->listProvisionedProductPlansAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProvisionedProductPlans([
    'AcceptLanguage' => '<string>',
    'AccessLevelFilter' => [
        'Key' => 'Account|Role|User',
        'Value' => '<string>',
    ],
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ProvisionProductId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'ProvisionedProductPlans' => [
        [
            'PlanId' => '<string>',
            'PlanName' => '<string>',
            'PlanType' => 'CLOUDFORMATION',
            'ProvisionProductId' => '<string>',
            'ProvisionProductName' => '<string>',
            'ProvisioningArtifactId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListProvisioningArtifacts

$result = $client->listProvisioningArtifacts([/* ... */]);
$promise = $client->listProvisioningArtifactsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProvisioningArtifacts([
    'AcceptLanguage' => '<string>',
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'ProvisioningArtifactDetails' => [
        [
            'Active' => true || false,
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Guidance' => 'DEFAULT|DEPRECATED',
            'Id' => '<string>',
            'Name' => '<string>',
            'SourceRevision' => '<string>',
            'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListProvisioningArtifactsForServiceAction

$result = $client->listProvisioningArtifactsForServiceAction([/* ... */]);
$promise = $client->listProvisioningArtifactsForServiceActionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProvisioningArtifactsForServiceAction([
    'AcceptLanguage' => '<string>',
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ServiceActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'ProvisioningArtifactViews' => [
        [
            'ProductViewSummary' => [
                'Distributor' => '<string>',
                'HasDefaultPath' => true || false,
                'Id' => '<string>',
                'Name' => '<string>',
                'Owner' => '<string>',
                'ProductId' => '<string>',
                'ShortDescription' => '<string>',
                'SupportDescription' => '<string>',
                'SupportEmail' => '<string>',
                'SupportUrl' => '<string>',
                'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE|TERRAFORM_OPEN_SOURCE|TERRAFORM_CLOUD|EXTERNAL',
            ],
            'ProvisioningArtifact' => [
                'CreatedTime' => <DateTime>,
                'Description' => '<string>',
                'Guidance' => 'DEFAULT|DEPRECATED',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found.

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListRecordHistory

$result = $client->listRecordHistory([/* ... */]);
$promise = $client->listRecordHistoryAsync([/* ... */]);

Lists the specified requests or all performed requests.

Parameter Syntax

$result = $client->listRecordHistory([
    'AcceptLanguage' => '<string>',
    'AccessLevelFilter' => [
        'Key' => 'Account|Role|User',
        'Value' => '<string>',
    ],
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'SearchFilter' => [
        'Key' => '<string>',
        'Value' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'NextPageToken' => '<string>',
    'RecordDetails' => [
        [
            'CreatedTime' => <DateTime>,
            'LaunchRoleArn' => '<string>',
            'PathId' => '<string>',
            'ProductId' => '<string>',
            'ProvisionedProductId' => '<string>',
            'ProvisionedProductName' => '<string>',
            'ProvisionedProductType' => '<string>',
            'ProvisioningArtifactId' => '<string>',
            'RecordErrors' => [
                [
                    'Code' => '<string>',
                    'Description' => '<string>',
                ],
                // ...
            ],
            'RecordId' => '<string>',
            'RecordTags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'RecordType' => '<string>',
            'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
            'UpdatedTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParametersException:

One or more parameters provided to the operation are not valid.

ListResourcesForTagOption

$result = $client->listResourcesForTagOption([/* ... */]);
$promise = $client->listResourcesForTagOptionAsync([/* ... */]);

Lists the resources associated with the specified TagOption.

Parameter Syntax

$result = $client->listResourcesForTagOption([
    'PageSize' => <integer>,
    'PageToken' => '<string>',
    'ResourceType' => '<string>',
    'TagOptionId' => '<string>', // REQUIRED
]);

Parameter Details