La référence d'API AWS Marketplace a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez le manuel AWS Marketplace API Reference.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Travailler avec des AMI-based produits

Vous pouvez utiliser le AWS Marketplace Catalog API pour automatiser les tâches liées à l'utilisation de produits basés sur Amazon Machine Image (AMI).

Pour plus d'informations sur la création d'un AMI-based produit à l'aide de l'API Catalog, consultezCréation d'un produit.

Les rubriques suivantes décrivent comment utiliser l'API Catalog pour effectuer des actions sur vos AMI-based produits :

Ajouter une nouvelle version

Vous pouvez utiliser l'API du catalogue pour ajouter une nouvelle version à un AMI-based produit existant dans AWS Marketplace. Pour plus d'informations sur l'ajout de nouvelles versions d'AMI à votre produit à l'aide du Portail de gestion AWS Marketplace, consultez la section Ajouter une nouvelle version dans le Guide du AWS Marketplace vendeur.

Lorsque vous créez une demande qui inclut l'ajout d'une nouvelle AMI à AWS Marketplace, l'AMI doit être copiée dans le système AWS Marketplace, puis scannée pour détecter tout problème de sécurité. Vous devez autoriser AWS Marketplace à accéder à l'AMI en créant un rôle AWS Identity and Access Management (IAM) autorisé à effectuer des actions sur votre AMI. Pour plus d'informations sur les autorisations requises, consultez la section Accorder à AWS Marktplace l'accès à votre AMI dans le Guide du AWS Marketplace vendeur.

Pour ajouter une nouvelle version, appelez l'opération StartChangeSet API avec le type de AddDeliveryOptions modification pour les AMI-based produits, comme indiqué dans l'exemple suivant. Pour tester votre appel d'API sans créer de nouvelle version, définissez le Intent paramètre surVALIDATE. Pour plus d'informations, consultez Intent.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "AmiProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "My new title",
          "ReleaseNotes": "My new Release notes"
        },
        "DeliveryOptions":
        [
          {
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "AmiSource":
                {
                  "AmiId": "ami-1234567890abcdef",
                  "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                  "UserName": "ec2-user",
                  "OperatingSystemName": "AMAZONLINUX",
                  "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2",
                  "AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products)
                },
                "UsageInstructions": "Easy to use AMI",
                "RecommendedInstanceType": "m4.xlarge",
                "SecurityGroups":
                [
                  {
                    "IpProtocol": "tcp",
                    "FromPort": 443,
                    "ToPort": 443,
                    "IpRanges":
                    [
                      "0.0.0.0/0"
                    ]
                  }
                ]
              }
            }
          },
          {
            "DeliveryOptionTitle": "My new AMI with CFTdelivery option",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {
                "ShortDescription": "My new short description",
                "LongDescription": "My new long description",
                "UsageInstructions": "My new usage instructions",
                "RecommendedInstanceType": "m4.xlarge",
                "ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png",
                "Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template",
                "TemplateSources":
                [
                  {
                    "ParameterName": "MyAmiParam",
                    "AmiSource":
                    {
                      "AmiId": "ami-1234567890abcdef",
                      "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                      "UserName": "ec2-user",
                      "OperatingSystemName": "AMAZONLINUX",
                      "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "Intent": "APPLY"
}

La liste suivante fournit des informations sur les champs de saisie que vous utilisez avec le type de AddDeliveryOptions modification. Tous les champs sont obligatoires, sauf indication contraire. Pour plus d'informations sur ces champs, consultez la section Ajouter une nouvelle version dans le Guide du AWS Marketplace vendeur.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Pour plus d'informations sur les erreurs dans les ensembles de modifications des produits proposés par les vendeurs, consultezModifier le statut et les erreurs du set.

Lorsque la demande est terminée, la version est ajoutée et tous les abonnés existants recevront un e-mail les informant de la nouvelle version. Pour plus d'informations sur le processus d'ajout d'une nouvelle version, consultez la section Ajouter une nouvelle version dans le Guide du AWS Marketplace vendeur.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Vous pouvez également créer un AMI-based produit à l'aide du Portail de gestion AWS Marketplace. Pour plus d'informations, consultez la section sur les produits AMI dans le Guide AWS Marketplace du vendeur.

Pour découvrir comment automatiser la mise à jour de votre AMI-based produit, vous pouvez également consulter la vidéo intitulée Automatiser les mises à jour de vos listes de produits AWS Marketplace avec l'API du catalogue (5:08).

Informations de version de mise à jour

Vous pouvez utiliser l'API du catalogue pour mettre à jour les détails d'une version existante de votre AMI-based produit dans AWS Marketplace.

Vous ne pouvez pas mettre à jour l'AMI pour cette version. Si vous devez mettre à jour l'AMI, créez plutôt une nouvelle version.

Pour ajouter une nouvelle version, appelez l'opération StartChangeSet API avec le type de UpdateDeliveryOptions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "*My new Release notes*"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "UsageInstructions": "Easy to use AMI"
              }
            }
          },
          {
            "Id": "example1-2222-dddd-2222-dddddddddddd",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {work with ami
                "DeliveryOptionTitle": "My updated delivery option title",
                "UsageInstructions": "Updated usage instructions here."
              }
            }
          }
        ]
      }
    }
  ]
}

Vous trouverez ci-dessous des informations sur les champs de saisie que vous fournissez pour ajouter le type de UpdateDeliveryOptions modification. Pour plus d'informations sur ces champs, consultez la section Mise à jour des informations de version dans le Guide du AWS Marketplace vendeur.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Pour plus d’informations sur les jeux de modifications, consultez Travailler avec des ensembles de modifications. Pour plus d'informations sur les erreurs dans les ensembles de modifications des produits proposés par les vendeurs, consultezModifier le statut et les erreurs du set.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Vous pouvez récupérer UpdatePricingTerms des actions en utilisant l'DescribeChangeSetopération une fois que le traitement de l'ensemble de modifications a commencé. Pour plus d'informations sur les détails des erreurs et la résolution des problèmesModifier le statut et les erreurs du set, reportez-vous à la section précédente de ce guide.

Restreindre une version

Vous pouvez utiliser l'API du catalogue pour restreindre une version de votre AMI-based produit. Cela empêche les nouveaux acheteurs d'utiliser cette version, mais la met à la disposition des acheteurs existants. Le fait de restreindre toutes les options de livraison d'une version restreint la version. Le fait de restreindre une ou plusieurs options de livraison d'une version, mais pas toutes, restreint uniquement les options de livraison de cette version. Vous devez toujours disposer d'au moins une version illimitée d'un produit. Vous ne pouvez donc pas restreindre la dernière version accessible au public d'un produit.

Pour restreindre une version, appelez l'opération StartChangeSet API avec le type de RestrictDeliveryOptions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

Les informations suivantes concernent les champs de saisie que vous fournissez pour ajouter le type de RestrictDeliveryOptions modification :

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux RestrictDeliveryOptions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Mettre à jour le futur Région AWS Prise en charge de par la  

Vous pouvez utiliser l'API du catalogue pour modifier les futures préférences d' Région AWS assistance pour votre AMI-based produit dans AWS Marketplace.

Pour modifier les futures préférences d' Région AWS assistance, appelez l'opération StartChangeSet API avec le type de UpdateFutureRegionSupport modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateFutureRegionSupport",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "FutureRegionSupport":
        {
          "SupportedRegions":
          [
            "All"
          ]
        }
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateFutureRegionSupport modification :

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateFutureRegionSupport actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Ajouter un support Région AWS

Vous pouvez utiliser l'API du catalogue pour ajouter de nouveaux produits pris en charge Régions AWS pour votre AMI-based produit dans AWS Marketplace.

Pour ajouter de nouvelles régions prises en charge, appelez l'opération StartChangeSet API avec le type de AddRegions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de AddRegions modification.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddRegions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Restreindre un Région AWS

Vous pouvez utiliser l'API du catalogue pour restreindre les fonctionnalités précédemment prises en charge Régions AWS pour votre AMI-based produit dans AWS Marketplace.

Pour restreindre les régions précédemment prises en charge, appelez l'opération StartChangeSet API avec le type de RestrictRegions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "RestrictRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de AddRegions modification.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddRegions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Ajouter un nouveau type d'instance

Vous pouvez utiliser l'API du catalogue pour ajouter de nouveaux types d'instances pour votre AMI-based produit dans AWS Marketplace.

AddInstanceTypesajoutera de nouveaux types d'instances aux produits existants et aux produits nouvellement créés lors de la création d'un produit. Le type de modification mettra à jour toutes les versions du document du produit avec un nouveau type d'instance.

Lors de l'ajout d'un type d'instance restreint, le type d'instance peut être supprimé de la liste restreinte et ajouté à la liste des types d'instance disponibles. Cela permet aux vendeurs de mieux contrôler la modification de leurs restrictions relatives aux produits. La liste des types d'instances est interchangeable et ne constitue pas un statut restreint permanent pour un produit.

Pour les produits mesurés en interne, les vendeurs doivent appeler des types de modification distincts AddDimensions et mettre UpdatePricingTerms à jour les prix pour le type d'instance.

Pour ajouter de nouveaux types d'instances, appelez l'opération StartChangeSet API avec le type de RestrictRegions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

Seul AddInstanceTypes le type de modification est indiqué ci-dessous. Bien que les vendeurs d'AMI dotés de compteurs internes soient tenus d'appeler AddInstanceTypes et de UpdatePricingTerms modifier le type de leur AMI.

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de AddInstanceTypes modification :

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux AddInstanceTypes actions du AWS Marketplace Catalog API. Ces validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux AddInstanceTypes actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.

Restreindre un type d'instance

Vous pouvez utiliser l'API du catalogue pour limiter ou restreindre les types d'instances disponibles pour votre AMI-based produit dans AWS Marketplace.

Les abonnés existants ne seront pas concernés par cette modification et pourront utiliser les types d'instances restreints. Toutefois, aucun nouvel acheteur ne pourra utiliser les types d'instances restreints. Pour arrêter les abonnements aux types d'instances actuels (une fois que les types d'instances sont restreints), vous devez contacter l'équipe des opérations des AWS Marketplace vendeurs.

RestrictInstanctTypesrestreint les types d'instances à toutes les versions du document du produit. Dans le type de AddInstanceTypes modification, vous mettez à jour toutes les versions du produit. Vous ne serez pas en mesure de restreindre les types d'instances recommandés. Le type d'instance recommandé se situe au niveau de la version. Il est donc possible que le vendeur ne soit pas en mesure de restreindre plusieurs types d'instances.

Pour un produit mesuré en interne, vous devez appeler des types de modification distincts lors de l'appelRestrictDimensions. Cela empêche la création de nouvelles offres pour les types d'instances restreints.

Pour limiter ou restreindre les types d'instances disponibles pour votre AMI-based produit, appelez l'opération d'StartChangeSetAPI avec le type de RestrictInstanceTypes modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de RestrictInstanceTypes modification.

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.

{
  "ChangeSetId": "example123456789012abcdef",
   "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

La demande de modification est ajoutée à une file d'attente et traitée. Cela comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux RestrictInstanceTypes actions du AWS Marketplace Catalog API. Ces validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux RestrictInstanceTypes actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.