AWS Marketplace Deployment Service

2023/11/30 - AWS Marketplace Deployment Service - 4 new api methods

Changes  AWS Marketplace Deployment is a new service that provides essential features that facilitate the deployment of software, data, and services procured through AWS Marketplace.

PutDeploymentParameter (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.put_deployment_parameter(
    agreementId='string',
    catalog='string',
    clientToken='string',
    deploymentParameter={
        'name': 'string',
        'secretString': 'string'
    },
    expirationDate=datetime(2015, 1, 1),
    productId='string',
    tags={
        'string': 'string'
    }
)
type agreementId

string

param agreementId

[REQUIRED]

The unique identifier of the agreement.

type catalog

string

param catalog

[REQUIRED]

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

type clientToken

string

param clientToken

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

This field is autopopulated if not provided.

type deploymentParameter

dict

param deploymentParameter

[REQUIRED]

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

  • name (string) -- [REQUIRED]

    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 (string) -- [REQUIRED]

    The text to encrypt and store in the secret.

type expirationDate

datetime

param expirationDate

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

type productId

string

param productId

[REQUIRED]

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

type tags

dict

param tags

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.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'agreementId': 'string',
    'deploymentParameterId': 'string',
    'resourceArn': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • agreementId (string) --

      The unique identifier of the agreement.

    • deploymentParameterId (string) --

      The unique identifier of the deployment parameter.

    • resourceArn (string) --

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

    • tags (dict) --

      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.

      • (string) --

        • (string) --

ListTagsForResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

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

      • (string) --

        • (string) --

UntagResource (new) Link ¶

Removes a tag or list of tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

type tagKeys

list

param tagKeys

[REQUIRED]

A list of key names of tags to be removed.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

TagResource (new) Link ¶

Tags a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn

string

param resourceArn

[REQUIRED]

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

type tags

dict

param tags

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --