Exemples de Service Catalog utilisant AWS CLI - AWS Command Line Interface
Actions

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.

Exemples de Service Catalog utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with Service Catalog.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utiliseraccept-portfolio-share.

AWS CLI

Pour accepter une part de portefeuille

L'accept-portfolio-shareexemple suivant accepte une offre, faite par un autre utilisateur, pour partager le portefeuille spécifié.

aws servicecatalog accept-portfolio-share \
    --portfolio-id port-2s6wuabcdefghijk

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserassociate-principal-with-portfolio.

AWS CLI

Pour associer un mandant à un portefeuille

L'associate-principal-with-portfolioexemple suivant associe un utilisateur au portefeuille spécifié.

aws servicecatalog associate-principal-with-portfolio \
    --portfolio-id port-2s6abcdefwdh4 \
    --principal-arn arn:aws:iam::123456789012:user/usertest \
    --principal-type IAM

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserassociate-product-with-portfolio.

AWS CLI

Pour associer un produit à un portefeuille

L'associate-product-with-portfolioexemple suivant associe le produit donné au portefeuille spécifié.

aws servicecatalog associate-product-with-portfolio
     --product-id prod-3p5abcdef3oyk
     --portfolio-id port-2s6abcdef5wdh4

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserassociate-tag-option-with-resource.

AWS CLI

Pour associer un TagOption à une ressource

L'associate-tag-option-with-resourceexemple suivant associe la ressource spécifiée TagOption à la ressource spécifiée.

aws servicecatalog associate-tag-option-with-resource \
    --resource-id port-2s6abcdq5wdh4 \
    --tag-option-id tag-p3abc2pkpz5qc

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utilisercopy-product.

AWS CLI

Pour copier un produit

L'copy-productexemple suivant crée une copie du produit spécifié en utilisant un JSON fichier pour transmettre les paramètres.

aws servicecatalog copy-product --cli-input-json file://copy-product-input.json

Contenu de copy-product-input.json :

{
    "SourceProductArn": "arn:aws:catalog:us-west-2:123456789012:product/prod-tcabcd3syn2xy",
    "TargetProductName": "copy-of-myproduct",
    "CopyOptions": [
        "CopyTags"
    ]
}

Sortie :

{
    "CopyProductToken": "copyproduct-abc5defgjkdji"
}

  • Pour API plus de détails, voir CopyProductla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-portfolio-share.

AWS CLI

Pour partager un portefeuille avec un compte

L'create-portfolio-shareexemple suivant partage le portefeuille spécifié avec le compte spécifié.

aws servicecatalog create-portfolio-share \
    --portfolio-id port-2s6abcdef5wdh4 \
    --account-id 794123456789

Cette commande ne produit aucune sortie.

L'exemple de code suivant montre comment utilisercreate-portfolio.

AWS CLI

Pour créer un portefeuille

L'create-portfolioexemple suivant crée un portefeuille.

aws servicecatalog create-portfolio  \
    --provider-name my-provider \
    --display-name my-portfolio

Sortie :

{
    "PortfolioDetail": {
        "ProviderName": "my-provider",
        "DisplayName": "my-portfolio",
        "CreatedTime": 1571337221.555,
        "ARN": "arn:aws:catalog:us-east-2:123456789012:portfolio/port-2s6xmplq5wdh4",
        "Id": "port-2s6xmplq5wdh4"
    }
}

  • Pour API plus de détails, voir CreatePortfoliola section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-product.

AWS CLI

Pour créer un produit

L'create-productexemple suivant crée un produit en utilisant un JSON fichier pour transmettre des paramètres.

aws servicecatalog create-product \
    --cli-input-json file://create-product-input.json

Contenu de create-product-input.json :

{
    "AcceptLanguage": "en",
    "Name": "test-product",
    "Owner": "test-owner",
    "Description": "test-description",
    "Distributor": "test-distributor",
    "SupportDescription": "test-support",
    "SupportEmail": "test@amazon.com",
    "SupportUrl": "https://aws.amazon.com",
    "ProductType": "CLOUD_FORMATION_TEMPLATE",
    "Tags": [
        {
            "Key": "region",
            "Value": "us-east-1"
        }
    ],
    "ProvisioningArtifactParameters": {
        "Name": "test-version-name",
        "Description": "test-version-description",
        "Info": {
            "LoadTemplateFromURL": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
        },
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

Sortie :

{
    "Tags": [
        {
            "Key": "region",
            "Value": "us-east-1"
        }
    ],
    "ProductViewDetail": {
        "CreatedTime": 1576025036.0,
        "ProductARN": "arn:aws:catalog:us-west-2:1234568542028:product/prod-3p5abcdef3oyk",
        "Status": "CREATED",
        "ProductViewSummary": {
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "Distributor": "test-distributor",
            "SupportUrl": "https://aws.amazon.com",
            "SupportEmail": "test@amazon.com",
            "Id": "prodview-abcd42wvx45um",
            "SupportDescription": "test-support",
            "ShortDescription": "test-description",
            "Owner": "test-owner",
            "Name": "test-product2",
            "HasDefaultPath": false,
            "ProductId": "prod-3p5abcdef3oyk"
        }
    },
    "ProvisioningArtifactDetail": {
        "CreatedTime": 1576025036.0,
        "Active": true,
        "Id": "pa-pq3p5lil12a34",
        "Description": "test-version-description",
        "Name": "test-version-name",
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

  • Pour API plus de détails, voir CreateProductla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-provisioning-artifact.

AWS CLI

Pour créer un artefact d'approvisionnement

L'create-provisioning-artifactexemple suivant crée un artefact de provisionnement en utilisant un JSON fichier pour transmettre des paramètres.

aws servicecatalog create-provisioning-artifact \
   --cli-input-json file://create-provisioning-artifact-input.json

Contenu de create-provisioning-artifact-input.json :

{
    "ProductId": "prod-nfi2abcdefghi",
    "Parameters": {
        "Name": "test-provisioning-artifact",
        "Description": "test description",
        "Info": {
            "LoadTemplateFromURL": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
        },
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

Sortie :

{
    "Info": {
        "TemplateUrl": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
    },
    "Status": "CREATING",
    "ProvisioningArtifactDetail": {
        "Id": "pa-bb4abcdefwnaio",
        "Name": "test-provisioning-artifact",
        "Description": "test description",
        "Active": true,
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "CreatedTime": 1576022545.0
    }
}

L'exemple de code suivant montre comment utilisercreate-tag-option.

AWS CLI

Pour créer un TagOption

L'create-tag-optionexemple suivant crée un TagOption.

aws servicecatalog create-tag-option
    --key 1234
    --value name

Sortie :

{
    "TagOptionDetail": {
    "Id": "tag-iabcdn4fzjjms",
    "Value": "name",
    "Active": true,
    "Key": "1234"
    }
}

  • Pour API plus de détails, voir CreateTagOptionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-portfolio-share.

AWS CLI

Pour arrêter de partager un portefeuille avec un compte

L'delete-portfolio-shareexemple suivant arrête de partager le portefeuille avec le compte spécifié.

aws servicecatalog delete-portfolio-share \
    --portfolio-id port-2s6abcdq5wdh4 \
    --account-id 123456789012

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserdelete-portfolio.

AWS CLI

Pour supprimer un portefeuille

L'delete-portfolioexemple suivant supprime le portefeuille spécifié.

aws servicecatalog delete-portfolio \
    --id port-abcdlx4gox4do

Cette commande ne produit aucun résultat.

  • Pour API plus de détails, voir DeletePortfoliola section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-product.

AWS CLI

Pour supprimer un produit

L'delete-productexemple suivant supprime le produit spécifié.

aws servicecatalog delete-product \
    --id prod-abcdcek6yhbxi

Cette commande ne produit aucun résultat.

  • Pour API plus de détails, voir DeleteProductla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-provisioning-artifact.

AWS CLI

Pour supprimer un artefact d'approvisionnement

L'delete-provisioning-artifactexemple suivant supprime l'artefact de provisionnement spécifié.

aws servicecatalog delete-provisioning-artifact \
    --product-id prod-abc2uebuplcpw \
    --provisioning-artifact-id pa-pqabcddii7ouc

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserdelete-tag-option.

AWS CLI

Pour supprimer un TagOption

L'delete-tag-optionexemple suivant supprime le paramètre spécifié TagOption.

aws servicecatalog delete-tag-option \
    --id tag-iabcdn4fzjjms

Cette commande ne produit aucun résultat.

  • Pour API plus de détails, voir DeleteTagOptionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-copy-product-status.

AWS CLI

Pour décrire l'état de l'opération de copie du produit

L'describe-copy-product-statusexemple suivant affiche l'état actuel de l'opération de copie asynchrone spécifiée.

aws servicecatalog describe-copy-product-status \
    --copy-product-token copyproduct-znn5tf5abcd3w

Sortie :

{
    "CopyProductStatus": "SUCCEEDED",
    "TargetProductId": "prod-os6hog7abcdt2"
}

L'exemple de code suivant montre comment utiliserdescribe-portfolio.

AWS CLI

Pour décrire un portefeuille

L'describe-portfolioexemple suivant affiche les détails du portefeuille spécifié.

aws servicecatalog describe-portfolio \
    --id port-2s6abcdq5wdh4

Sortie :

{
    "TagOptions": [],
    "PortfolioDetail": {
        "ARN": "arn:aws:catalog:us-west-2:687558541234:portfolio/port-2s6abcdq5wdh4",
        "Id": "port-2s6wuzyq5wdh4",
        "CreatedTime": 1571337221.555,
        "DisplayName": "my-portfolio",
        "ProviderName": "my-provider"
    },
    "Tags": []
}

  • Pour API plus de détails, voir DescribePortfoliola section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-product-as-admin.

AWS CLI

Pour décrire un produit en tant qu'administrateur

L'describe-product-as-adminexemple suivant affiche les détails du produit spécifié à l'aide des privilèges d'administrateur.

aws servicecatalog describe-product-as-admin \
    --id prod-abcdcek6yhbxi

Sortie :

{
    "TagOptions": [],
    "ProductViewDetail": {
        "ProductARN": "arn:aws:catalog:us-west-2:687558542028:product/prod-abcdcek6yhbxi",
        "ProductViewSummary": {
            "SupportEmail": "test@amazon.com",
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "Distributor": "test-distributor",
            "ShortDescription": "test-description",
            "Owner": "test-owner",
            "Id": "prodview-wi3l2j4abc6vc",
            "SupportDescription": "test-support",
            "ProductId": "prod-abcdcek6yhbxi",
            "HasDefaultPath": false,
            "Name": "test-product3",
            "SupportUrl": "https://aws.amazon.com"
        },
        "CreatedTime": 1577136715.0,
        "Status": "CREATED"
    },
    "ProvisioningArtifactSummaries": [
        {
            "CreatedTime": 1577136715.0,
            "Description": "test-version-description",
            "ProvisioningArtifactMetadata": {
                "SourceProvisioningArtifactId": "pa-abcdxkkiv5fcm"
            },
            "Name": "test-version-name-3",
            "Id": "pa-abcdxkkiv5fcm"
        }
    ],
    "Tags": [
        {
            "Value": "iad",
            "Key": "region"
        }
    ]
}

L'exemple de code suivant montre comment utiliserdescribe-provisioned-product.

AWS CLI

Pour décrire un produit approvisionné

L'describe-provisioned-productexemple suivant affiche les détails du produit approvisionné spécifié.

aws servicecatalog describe-provisioned-product \
    --id pp-dpom27bm4abcd

Sortie :

{
    "ProvisionedProductDetail": {
        "Status": "ERROR",
        "CreatedTime": 1577222793.358,
        "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-dpom27bm4abcd",
        "Id": "pp-dpom27bm4abcd",
        "StatusMessage": "AmazonCloudFormationException  Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)",
        "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42",
        "LastRecordId": "rec-tfuawdjovzxge",
        "Type": "CFN_STACK",
        "Name": "mytestppname3"
    },
    "CloudWatchDashboards": []
}

L'exemple de code suivant montre comment utiliserdescribe-provisioning-artifact.

AWS CLI

Pour décrire un artefact d'approvisionnement

L'describe-provisioning-artifactexemple suivant affiche les détails de l'artefact de provisionnement spécifié.

aws servicecatalog describe-provisioning-artifact \
    --provisioning-artifact-id pa-pcz347abcdcfm \
    --product-id prod-abcdfz3syn2rg

Sortie :

{
    "Info": {
        "TemplateUrl": "https://awsdocs.s3.amazonaws.com/servicecatalog/myexampledevelopment-environment.template"
    },
    "ProvisioningArtifactDetail": {
        "Id": "pa-pcz347abcdcfm",
        "Active": true,
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "Description": "updated description",
        "CreatedTime": 1562097906.0,
        "Name": "updated name"
    },
    "Status": "AVAILABLE"
}

L'exemple de code suivant montre comment utiliserdescribe-tag-option.

AWS CLI

Pour décrire un TagOption

L'describe-tag-optionexemple suivant affiche les détails de ce qui est spécifié TagOption.

aws servicecatalog describe-tag-option \
    --id tag-p3tej2abcd5qc

Sortie :

{
    "TagOptionDetail": {
        "Active": true,
        "Id": "tag-p3tej2abcd5qc",
        "Value": "value-3",
        "Key": "1234"
    }
}

  • Pour API plus de détails, voir DescribeTagOptionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdisassociate-principal-from-portfolio.

AWS CLI

Pour dissocier un capital d'un portefeuille

L'disassociate-principal-from-portfolioexemple suivant dissocie le capital spécifié du portefeuille.

aws servicecatalog disassociate-principal-from-portfolio \
    --portfolio-id port-2s6abcdq5wdh4 \
    --principal-arn arn:aws:iam::123456789012:group/myendusers

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserdisassociate-product-from-portfolio.

AWS CLI

Pour dissocier un produit d'un portefeuille

L'disassociate-product-from-portfolioexemple suivant dissocie le produit spécifié du portefeuille.

aws servicecatalog disassociate-product-from-portfolio \
    --product-id prod-3p5abcdmu3oyk \
    --portfolio-id port-2s6abcdq5wdh4

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserdisassociate-tag-option-from-resource.

AWS CLI

Pour dissocier une TagOption ressource

L'disassociate-tag-option-from-resourceexemple suivant dissocie le spécifié TagOption de la ressource.

aws servicecatalog disassociate-tag-option-from-resource \
     --resource-id port-2s6abcdq5wdh4 \
     --tag-option-id tag-p3abc2pkpz5qc

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserlist-accepted-portfolio-shares.

AWS CLI

Pour répertorier les actions de portefeuille acceptées

L'list-accepted-portfolio-sharesexemple suivant répertorie tous les portefeuilles pour lesquels le partage a été accepté par ce compte, y compris uniquement les portefeuilles Service Catalog par défaut.

aws servicecatalog list-accepted-portfolio-shares \
    --portfolio-share-type "AWS_SERVICECATALOG"

Sortie :

{
    "PortfolioDetails": [
        {
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-d2abcd5dpkuma",
            "Description": "AWS Service Catalog Reference blueprints for often-used AWS services such as EC2, S3, RDS, VPC and EMR.",
            "CreatedTime": 1574456190.687,
            "ProviderName": "AWS Service Catalog",
            "DisplayName": "Reference Architectures",
            "Id": "port-d2abcd5dpkuma"
        },
        {
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-abcdefaua7zpu",
            "Description": "AWS well-architected blueprints for high reliability applications.",
            "CreatedTime": 1574461496.092,
            "ProviderName": "AWS Service Catalog",
            "DisplayName": "High Reliability Architectures",
            "Id": "port-abcdefaua7zpu"
        }
    ]
}

L'exemple de code suivant montre comment utiliserlist-portfolio-access.

AWS CLI

Pour répertorier les comptes ayant accès à un portefeuille

L'list-portfolio-accessexemple suivant répertorie les AWS comptes qui ont accès au portefeuille spécifié.

aws servicecatalog list-portfolio-access \
    --portfolio-id port-2s6abcdq5wdh4

Sortie :

{
    "AccountIds": [
        "123456789012"
    ]
}

  • Pour API plus de détails, voir ListPortfolioAccessla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-portfolios-for-product.

AWS CLI

Pour répertorier les portefeuilles associés à un produit

L'list-portfolios-for-productexemple suivant répertorie les portefeuilles associés au produit spécifié.

aws servicecatalog list-portfolios-for-product \
    --product-id prod-abcdfz3syn2rg

Sortie :

{
    "PortfolioDetails": [
        {
            "CreatedTime": 1571337221.555,
            "Id": "port-2s6abcdq5wdh4",
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-2s6abcdq5wdh4",
            "DisplayName": "my-portfolio",
            "ProviderName": "my-provider"
        },
        {
            "CreatedTime": 1559665256.348,
            "Id": "port-5abcd3e5st4ei",
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-5abcd3e5st4ei",
            "DisplayName": "test",
            "ProviderName": "provider-name"
        }
    ]
}

L'exemple de code suivant montre comment utiliserlist-portfolios.

AWS CLI

Pour répertorier les portefeuilles

L'list-portfoliosexemple suivant répertorie les portefeuilles Service Catalog de la région actuelle.

aws servicecatalog list-portfolios

Sortie :

{
    "PortfolioDetails": [
        {
           "CreatedTime": 1559665256.348,
           "ARN": "arn:aws:catalog:us-east-2:123456789012:portfolio/port-5pzcxmplst4ei",
           "DisplayName": "my-portfolio",
           "Id": "port-5pzcxmplst4ei",
           "ProviderName": "my-user"
        }
    ]
}

  • Pour API plus de détails, voir ListPortfoliosla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-principals-for-portfolio.

AWS CLI

Pour répertorier tous les principaux d'un portefeuille

L'list-principals-for-portfolioexemple suivant répertorie tous les principes du portefeuille spécifié.

aws servicecatalog list-principals-for-portfolio \
    --portfolio-id port-2s6abcdq5wdh4

Sortie :

{
    "Principals": [
        {
            "PrincipalARN": "arn:aws:iam::123456789012:user/usertest",
            "PrincipalType": "IAM"
        }
    ]
}

L'exemple de code suivant montre comment utiliserlist-provisioning-artifacts.

AWS CLI

Pour répertorier tous les artefacts d'approvisionnement d'un produit

L'list-provisioning-artifactsexemple suivant répertorie tous les artefacts d'approvisionnement pour le produit spécifié.

aws servicecatalog list-provisioning-artifacts \
    --product-id prod-nfi2abcdefgcpw

Sortie :

{
    "ProvisioningArtifactDetails": [
        {
            "Id": "pa-abcdef54ipm6z",
            "Description": "test-version-description",
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "CreatedTime": 1576021147.0,
            "Active": true,
            "Name": "test-version-name"
        },
        {
            "Id": "pa-bb4zyxwwnaio",
            "Description": "test description",
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "CreatedTime": 1576022545.0,
            "Active": true,
            "Name": "test-provisioning-artifact-2"
        }
    ]
}

L'exemple de code suivant montre comment utiliserlist-resources-for-tag-option.

AWS CLI

Pour répertorier les ressources associées à un TagOption

L'list-resources-for-tag-optionexemple suivant répertorie les ressources associées aux informations spécifiéesTagOption.

aws servicecatalog list-resources-for-tag-option \
    --tag-option-id tag-p3tej2abcd5qc

Sortie :

{
    "ResourceDetails": [
        {
            "ARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
            "Name": "my product",
            "Description": "description",
            "CreatedTime": 1562097906.0,
            "Id": "prod-abcdfz3syn2rg"
        }
    ]
}

L'exemple de code suivant montre comment utiliserlist-tag-options.

AWS CLI

L'list-tag-optionsexemple suivant répertorie toutes les valeurs deTagOptions.

aws servicecatalog list-tag-options

Sortie :

{
    "TagOptionDetails": [
        {
            "Value": "newvalue",
            "Active": true,
            "Id": "tag-iabcdn4fzjjms",
            "Key": "1234"
        },
        {
            "Value": "value1",
            "Active": true,
            "Id": "tag-e3abcdvmwvrzy",
            "Key": "key"
        }
    ]
}

  • Pour API plus de détails, voir ListTagOptionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserprovision-product.

AWS CLI

Pour approvisionner un produit

L'provision-productexemple suivant approvisionne le produit spécifié à l'aide de l'artefact d'approvisionnement spécifié.

aws servicecatalog provision-product \
    --product-id prod-abcdfz3syn2rg \
    --provisioning-artifact-id pa-abc347pcsccfm \
    --provisioned-product-name "mytestppname3"

Sortie :

{
    "RecordDetail": {
        "RecordId": "rec-tfuawdabcdege",
        "CreatedTime": 1577222793.362,
        "ProvisionedProductId": "pp-abcd27bm4mldq",
        "PathId": "lpv2-abcdg3jp6t5k6",
        "RecordErrors": [],
        "ProductId": "prod-abcdfz3syn2rg",
        "UpdatedTime": 1577222793.362,
        "RecordType": "PROVISION_PRODUCT",
        "ProvisionedProductName": "mytestppname3",
        "ProvisioningArtifactId": "pa-pcz347abcdcfm",
        "RecordTags": [],
        "Status": "CREATED",
        "ProvisionedProductType": "CFN_STACK"
    }
}

  • Pour API plus de détails, voir ProvisionProductla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserreject-portfolio-share.

AWS CLI

Pour rejeter une action de portefeuille

L'reject-portfolio-shareexemple suivant rejette la part du portefeuille pour le portefeuille donné.

aws servicecatalog reject-portfolio-share \
    --portfolio-id port-2s6wuabcdefghijk

Cette commande ne produit aucun résultat.

L'exemple de code suivant montre comment utiliserscan-provisioned-products.

AWS CLI

Pour répertorier tous les produits approvisionnés disponibles

L'scan-provisioned-productsexemple suivant répertorie les produits provisionnés disponibles.

aws servicecatalog scan-provisioned-products

Sortie :

{
    "ProvisionedProducts": [
        {
            "Status": "ERROR",
            "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-abcd27bm4mldq",
            "StatusMessage": "AmazonCloudFormationException  Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)",
            "Id": "pp-abcd27bm4mldq",
            "Type": "CFN_STACK",
            "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42",
            "CreatedTime": 1577222793.358,
            "Name": "mytestppname3",
            "LastRecordId": "rec-tfuawdabcdxge"
        }
    ]
}

L'exemple de code suivant montre comment utilisersearch-products-as-admin.

AWS CLI

Pour rechercher des produits dotés de privilèges d'administrateur

L'search-products-as-adminexemple suivant recherche des produits dotés de privilèges d'administrateur, en utilisant un identifiant de portefeuille comme filtre.

aws servicecatalog search-products-as-admin \
    --portfolio-id port-5abcd3e5st4ei

Sortie :

{
    "ProductViewDetails": [
        {
            "ProductViewSummary": {
                "Name": "my product",
                "Owner": "owner name",
                "Type": "CLOUD_FORMATION_TEMPLATE",
                "ProductId": "prod-abcdfz3syn2rg",
                "HasDefaultPath": false,
                "Id": "prodview-abcdmyuzv2dlu",
                "ShortDescription": "description"
            },
            "ProductARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
            "CreatedTime": 1562097906.0,
            "Status": "CREATED"
        }
    ]
}

L'exemple de code suivant montre comment utilisersearch-provisioned-products.

AWS CLI

Pour rechercher des produits approvisionnés

L'search-provisioned-productsexemple suivant recherche les produits approvisionnés correspondant à l'ID de produit spécifié, en utilisant un JSON fichier pour transmettre les paramètres.

aws servicecatalog search-provisioned-products \
    --cli-input-json file://search-provisioned-products-input.json

Contenu de search-provisioned-products-input.json :

{
    "Filters": {
        "SearchQuery": [
            "prod-tcjvfz3syn2rg"
        ]
    }
}

Sortie :

{
    "ProvisionedProducts": [
        {
            "ProvisioningArtifactId": "pa-pcz347abcdcfm",
            "Name": "mytestppname3",
            "CreatedTime": 1577222793.358,
            "Id": "pp-abcd27bm4mldq",
            "Status": "ERROR",
            "UserArn": "arn:aws:iam::123456789012:user/cliuser",
            "StatusMessage": "AmazonCloudFormationException  Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)",
            "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-abcd27bm4mldq",
            "Tags": [
                {
                    "Value": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
                    "Key": "aws:servicecatalog:productArn"
                },
                {
                    "Value": "arn:aws:iam::123456789012:user/cliuser",
                    "Key": "aws:servicecatalog:provisioningPrincipalArn"
                },
                {
                    "Value": "value-3",
                    "Key": "1234"
                },
                {
                    "Value": "pa-pcz347abcdcfm",
                    "Key": "aws:servicecatalog:provisioningArtifactIdentifier"
                },
                {
                    "Value": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-2s6abcdq5wdh4",
                    "Key": "aws:servicecatalog:portfolioArn"
                },
                {
                    "Value": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-abcd27bm4mldq",
                    "Key": "aws:servicecatalog:provisionedProductArn"
                }
            ],
            "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42",
            "UserArnSession": "arn:aws:iam::123456789012:user/cliuser",
            "Type": "CFN_STACK",
            "LastRecordId": "rec-tfuawdabcdxge",
            "ProductId": "prod-abcdfz3syn2rg"
        }
    ],
    "TotalResultsCount": 1
}

L'exemple de code suivant montre comment utiliserupdate-portfolio.

AWS CLI

Pour mettre à jour un portefeuille

L'update-portfolioexemple suivant met à jour le nom du portefeuille spécifié.

aws servicecatalog update-portfolio \
    --id port-5abcd3e5st4ei \
    --display-name "New portfolio name"

Sortie :

{
    "PortfolioDetail": {
        "DisplayName": "New portfolio name",
        "ProviderName": "provider",
        "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-5abcd3e5st4ei",
        "Id": "port-5abcd3e5st4ei",
        "CreatedTime": 1559665256.348
    },
    "Tags": []
}

  • Pour API plus de détails, voir UpdatePortfoliola section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-product.

AWS CLI

Pour mettre à jour un produit

L'update-productexemple suivant met à jour le nom et le propriétaire du produit spécifié.

aws servicecatalog update-product \
    --id prod-os6abc7drqlt2 \
    --name "New product name" \
    --owner "Updated product owner"

Sortie :

{
    "Tags": [
        {
            "Value": "iad",
            "Key": "region"
        }
    ],
    "ProductViewDetail": {
        "ProductViewSummary": {
            "Owner": "Updated product owner",
            "ProductId": "prod-os6abc7drqlt2",
            "Distributor": "test-distributor",
            "SupportUrl": "https://aws.amazon.com",
            "Name": "New product name",
            "ShortDescription": "test-description",
            "HasDefaultPath": false,
            "Id": "prodview-6abcdgrfhvidy",
            "SupportDescription": "test-support",
            "SupportEmail": "test@amazon.com",
            "Type": "CLOUD_FORMATION_TEMPLATE"
        },
        "Status": "CREATED",
        "ProductARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-os6abc7drqlt2",
        "CreatedTime": 1577136255.0
    }
}

  • Pour API plus de détails, voir UpdateProductla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-provisioning-artifact.

AWS CLI

Pour mettre à jour un artefact d'approvisionnement

L'update-provisioning-artifactexemple suivant met à jour le nom et la description de l'artefact de provisionnement spécifié, en utilisant un JSON fichier pour transmettre les paramètres.

aws servicecatalog update-provisioning-artifact \
    --cli-input-json file://update-provisioning-artifact-input.json

Contenu de update-provisioning-artifact-input.json :

{
    "ProductId": "prod-abcdfz3syn2rg",
    "ProvisioningArtifactId": "pa-pcz347abcdcfm",
    "Name": "updated name",
    "Description": "updated description"
}

Sortie :

{
    "Info": {
        "TemplateUrl": "https://awsdocs.s3.amazonaws.com/servicecatalog/myexampledevelopment-environment.template"
    },
    "Status": "AVAILABLE",
    "ProvisioningArtifactDetail": {
        "Active": true,
        "Description": "updated description",
        "Id": "pa-pcz347abcdcfm",
        "Name": "updated name",
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "CreatedTime": 1562097906.0
    }
}

L'exemple de code suivant montre comment utiliserupdate-tag-option.

AWS CLI

Pour mettre à jour un TagOption

L'update-tag-optionexemple suivant met à jour la valeur de TagOption a en utilisant le JSON fichier spécifié.

aws servicecatalog update-tag-option --cli-input-json file://update-tag-option-input.json

Contenu de update-tag-option-input.json :

{
    "Id": "tag-iabcdn4fzjjms",
    "Value": "newvalue",
    "Active": true
}

Sortie :

{
    "TagOptionDetail": {
        "Value": "newvalue",
        "Key": "1234",
        "Active": true,
        "Id": "tag-iabcdn4fzjjms"
    }
}

  • Pour API plus de détails, voir UpdateTagOptionla section Référence des AWS CLI commandes.