Exemples d’utilisation de l’AWS CLI avec Service Catalog - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec Service Catalog

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec 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 indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser accept-portfolio-share.

AWS CLI

Pour accepter le partage d’un portefeuille

L’exemple accept-portfolio-share suivant accepte l’offre de partage du portefeuille spécifié émanant d’un autre utilisateur.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez AcceptPortfolioShare dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser associate-principal-with-portfolio.

AWS CLI

Pour associer un principal à un portefeuille

L’exemple associate-principal-with-portfolio 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 aucune sortie.

L’exemple de code suivant montre comment utiliser associate-product-with-portfolio.

AWS CLI

Pour associer un produit à un portefeuille

L’exemple associate-product-with-portfolio suivant associe le produit spécifié au portefeuille spécifié.

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

Cette commande ne produit aucune sortie.

L’exemple de code suivant montre comment utiliser associate-tag-option-with-resource.

AWS CLI

Pour associer une TagOption à une ressource

L’exemple associate-tag-option-with-resource suivant associe la TagOption spécifiée à 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 aucune sortie.

L’exemple de code suivant montre comment utiliser copy-product.

AWS CLI

Pour copier un produit

L’exemple copy-product suivant crée une copie du produit spécifié en utilisant un fichier JSON 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 plus de détails sur l’API, consultez CopyProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-portfolio-share.

AWS CLI

Pour partager un portefeuille avec un compte

L’exemple create-portfolio-share 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 génère pas de sortie.

  • Pour plus de détails sur l’API, consultez CreatePortfolioShare dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-portfolio.

AWS CLI

Pour créer un portefeuille

L’exemple create-portfolio 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 plus de détails sur l’API, consultez CreatePortfolio dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-product.

AWS CLI

Pour créer un produit

L’exemple create-product suivant crée un produit en utilisant un fichier JSON 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 plus de détails sur l’API, consultez CreateProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-provisioning-artifact.

AWS CLI

Pour créer un artefact de provisionnement

L’exemple create-provisioning-artifact suivant crée un artefact de provisionnement en utilisant un fichier JSON pour transmettre les 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 utiliser create-tag-option.

AWS CLI

Pour créer une TagOption

L’exemple suivant create-tag-option crée une TagOption.

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

Sortie :

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

  • Pour plus de détails sur l’API, consultez CreateTagOption dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-portfolio-share.

AWS CLI

Pour arrêter le partage d’un portefeuille avec un compte

L’exemple delete-portfolio-share suivant arrête le partage du portefeuille avec le compte spécifié.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez DeletePortfolioShare dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-portfolio.

AWS CLI

Pour supprimer un portefeuille

L’exemple delete-portfolio suivant supprime le portefeuille spécifié.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez DeletePortfolio dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-product.

AWS CLI

Pour supprimer un produit

L’exemple delete-product suivant supprime le produit spécifié.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez DeleteProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-provisioning-artifact.

AWS CLI

Pour supprimer un artefact de provisionnement

L’exemple delete-provisioning-artifact 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 aucune sortie.

L’exemple de code suivant montre comment utiliser delete-tag-option.

AWS CLI

Pour supprimer une TagOption

L’exemple delete-tag-option suivant supprime la TagOption spécifiée.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez DeleteTagOption dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-copy-product-status.

AWS CLI

Pour décrire le statut de l’opération de copie de produit

L’exemple describe-copy-product-status suivant affiche le statut en cours de l’opération de copie de produit 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 utiliser describe-portfolio.

AWS CLI

Pour décrire un portefeuille

L’exemple describe-portfolio 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 plus de détails sur l’API, consultez DescribePortfolio dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-product-as-admin.

AWS CLI

Pour décrire un produit en tant qu’administrateur

L’exemple describe-product-as-admin 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"
        }
    ]
}

  • Pour plus de détails sur l’API, consultez DescribeProductAsAdmin dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-provisioned-product.

AWS CLI

Pour décrire un produit provisionné

L’exemple describe-provisioned-product suivant affiche les détails du produit provisionné 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 utiliser describe-provisioning-artifact.

AWS CLI

Pour décrire un artefact de provisionnement

L’exemple describe-provisioning-artifact 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 utiliser describe-tag-option.

AWS CLI

Pour décrire une TagOption

L’exemple describe-tag-option suivant affiche les détails de la TagOption spécifiée.

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

Sortie :

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

  • Pour plus de détails sur l’API, consultez DescribeTagOption dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disassociate-principal-from-portfolio.

AWS CLI

Pour dissocier un principal d’un portefeuille

L’exemple disassociate-principal-from-portfolio suivant dissocie le principal 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 aucune sortie.

L’exemple de code suivant montre comment utiliser disassociate-product-from-portfolio.

AWS CLI

Pour dissocier un produit d’un portefeuille

L’exemple disassociate-product-from-portfolio 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 aucune sortie.

L’exemple de code suivant montre comment utiliser disassociate-tag-option-from-resource.

AWS CLI

Pour dissocier une TagOption d’une ressource

L’exemple disassociate-tag-option-from-resource suivant dissocie la TagOption spécifiée de la ressource.

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

Cette commande ne produit aucune sortie.

L’exemple de code suivant montre comment utiliser list-accepted-portfolio-shares.

AWS CLI

Pour répertorier les partages de portefeuille acceptés

L’exemple list-accepted-portfolio-shares suivant répertorie tous les portefeuilles dont le partage a été accepté par ce compte, y compris 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 utiliser list-portfolio-access.

AWS CLI

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

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

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

Sortie :

{
    "AccountIds": [
        "123456789012"
    ]
}

  • Pour plus de détails sur l’API, consultez ListPortfolioAccess dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-portfolios-for-product.

AWS CLI

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

L’exemple list-portfolios-for-product 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"
        }
    ]
}

  • Pour plus de détails sur l’API, consultez ListPortfoliosForProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-portfolios.

AWS CLI

Pour répertorier les portefeuilles

L’exemple list-portfolios suivant répertorie les portefeuilles Service Catalog de la région en cours.

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 plus de détails sur l’API, consultez ListPortfolios dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-principals-for-portfolio.

AWS CLI

Pour répertorier tous les principaux d’un portefeuille

L’exemple list-principals-for-portfolio suivant répertorie tous les principaux 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 utiliser list-provisioning-artifacts.

AWS CLI

Pour répertorier tous les artefacts de provisionnement d’un produit

L’exemple list-provisioning-artifacts suivant répertorie tous les artefacts de provisionnement du 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 utiliser list-resources-for-tag-option.

AWS CLI

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

L’exemple list-resources-for-tag-option suivant répertorie toutes les ressources associées à la TagOption spécifiée.

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 utiliser list-tag-options.

AWS CLI

L’exemple list-tag-options suivant répertorie toutes les valeurs de TagOptions.

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 plus de détails sur l’API, consultez ListTagOptions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser provision-product.

AWS CLI

Pour provisionner un produit

L’exemple provision-product suivant provisionne le produit spécifié à l’aide de l’artefact de provisionnement 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 plus de détails sur l’API, consultez ProvisionProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reject-portfolio-share.

AWS CLI

Pour refuser le partage d’un portefeuille

L’exemple reject-portfolio-share suivant refuse le partage du portefeuille spécifié.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez RejectPortfolioShare dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser scan-provisioned-products.

AWS CLI

Pour répertorier tous les produits provisionnés disponibles

L’exemple scan-provisioned-products 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"
        }
    ]
}

  • Pour plus de détails sur l’API, consultez ScanProvisionedProducts dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser search-products-as-admin.

AWS CLI

Pour rechercher les produits dotés de privilèges d’administrateur

L’exemple search-products-as-admin suivant recherche les produits dotés de privilèges d’administrateur en utilisant un ID 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"
        }
    ]
}

  • Pour plus de détails sur l’API, consultez SearchProductsAsAdmin dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser search-provisioned-products.

AWS CLI

Pour rechercher des produits provisionnés

L’exemple search-provisioned-products suivant recherche les produits provisionnés correspondant à l’ID de produit spécifié en utilisant un fichier JSON 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 utiliser update-portfolio.

AWS CLI

Pour mettre à jour un portefeuille

L’exemple update-portfolio 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 plus de détails sur l’API, consultez UpdatePortfolio dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-product.

AWS CLI

Pour mettre à jour un produit

L’exemple update-product 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 plus de détails sur l’API, consultez UpdateProduct dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-provisioning-artifact.

AWS CLI

Pour mettre à jour un artefact de provisionnement

L’exemple update-provisioning-artifact suivant met à jour le nom et la description de l’artefact de provisionnement spécifié en utilisant un fichier JSON 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 utiliser update-tag-option.

AWS CLI

Pour mettre à jour une TagOption

L’exemple update-tag-option suivant met à jour la valeur d’une TagOption en utilisant le fichier JSON 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 plus de détails sur l’API, consultez UpdateTagOption dans la Référence des commandes de l’AWS CLI.