SDK for PHP 3.x

AWS Marketplace Deployment Service 2023-01-25

Client: Aws\MarketplaceDeployment\MarketplaceDeploymentClient
Service ID: marketplace-deployment
Version: 2023-01-25

This page describes the parameters and results for the operations of the AWS Marketplace Deployment Service (2023-01-25), and shows how to use the Aws\MarketplaceDeployment\MarketplaceDeploymentClient object to call the described operations. This documentation is specific to the 2023-01-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ListTagsForResource ( array $params = [] )
Lists all tags that have been added to a deployment parameter resource.
PutDeploymentParameter ( array $params = [] )
Creates or updates a deployment parameter and is targeted by catalog and agreementId.
TagResource ( array $params = [] )
Tags a resource.
UntagResource ( array $params = [] )
Removes a tag or list of tags from a resource.

Operations

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags that have been added to a deployment parameter resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to list tags on.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String) to strings

A map of key-value pairs, where each pair represents a tag present on the resource.

Errors

ThrottlingException:

Too many requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource wasn't found.

ValidationException:

An error occurred during validation.

InternalServerException:

There was an internal service exception.

PutDeploymentParameter 

$result = $client->putDeploymentParameter([/* ... */]);
$promise = $client->putDeploymentParameterAsync([/* ... */]);

Creates or updates a deployment parameter and is targeted by catalog and agreementId.

Parameter Syntax

$result = $client->putDeploymentParameter([
    'agreementId' => '<string>', // REQUIRED
    'catalog' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'deploymentParameter' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'secretString' => '<string>', // REQUIRED
    ],
    'expirationDate' => <integer || string || DateTime>,
    'productId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
agreementId
Required: Yes
Type: string

The unique identifier of the agreement.

catalog
Required: Yes
Type: string

The catalog related to the request. Fixed value: AWS Marketplace

clientToken
Type: string

The idempotency token for deployment parameters. A unique identifier for the new version.

deploymentParameter
Required: Yes
Type: DeploymentParameterInput structure

The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secret Manager resource.

expirationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when deployment parameters expire and are scheduled for deletion.

productId
Required: Yes
Type: string

The product for which AWS Marketplace will save secrets for the buyer’s account.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.

Result Syntax

[
    'agreementId' => '<string>',
    'deploymentParameterId' => '<string>',
    'resourceArn' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
agreementId
Required: Yes
Type: string

The unique identifier of the agreement.

deploymentParameterId
Required: Yes
Type: string

The unique identifier of the deployment parameter.

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to create or update.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.

Errors

ThrottlingException:

Too many requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource wasn't found.

ServiceQuotaExceededException:

The maximum number of requests per account has been exceeded.

ConflictException:

The request configuration has conflicts. For details, see the accompanying error message.

ValidationException:

An error occurred during validation.

InternalServerException:

There was an internal service exception.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource you want to tag.

tags
Type: Associative array of custom strings keys (String) to strings

A map of key-value pairs, where each pair represents a tag present on the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

Too many requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource wasn't found.

ConflictException:

The request configuration has conflicts. For details, see the accompanying error message.

ValidationException:

An error occurred during validation.

InternalServerException:

There was an internal service exception.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or list of tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

tagKeys
Required: Yes
Type: Array of strings

A list of key names of tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

Too many requests.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource wasn't found.

ConflictException:

The request configuration has conflicts. For details, see the accompanying error message.

ValidationException:

An error occurred during validation.

InternalServerException:

There was an internal service exception.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

ConflictException

Description

The request configuration has conflicts. For details, see the accompanying error message.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The unique identifier for the resource associated with the error.

DeploymentParameterInput

Description

The shape containing the requested deployment parameter name and secretString.

Members
name
Required: Yes
Type: string

The desired name of the deployment parameter. This is the identifier on which deployment parameters are keyed for a given buyer and product. If this name matches an existing deployment parameter, this request will update the existing resource.

secretString
Required: Yes
Type: string

The text to encrypt and store in the secret.

InternalServerException

Description

There was an internal service exception.

Members
message
Required: Yes
Type: string

ResourceNotFoundException

Description

The specified resource wasn't found.

Members
message
Required: Yes
Type: string

ServiceQuotaExceededException

Description

The maximum number of requests per account has been exceeded.

Members
message
Required: Yes
Type: string

ThrottlingException

Description

Too many requests.

Members
message
Required: Yes
Type: string

ValidationException

Description

An error occurred during validation.

Members
fieldName
Required: Yes
Type: string

The field name associated with the error.

message
Required: Yes
Type: string