View a markdown version of this page

Esempi di Service Catalog utilizzando AWS CLI - AWS Esempi di codice SDK
Azioni

Sono disponibili altri esempi AWS SDK nel repository AWS Doc SDK Examples. GitHub

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Esempi di Service Catalog utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with Service Catalog.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come usare. accept-portfolio-share

AWS CLI

Come accettare una condivisione di portafoglio

L’esempio accept-portfolio-share seguente accetta un’offerta, effettuata da un altro utente, per condividere il portafoglio specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. associate-principal-with-portfolio

AWS CLI

Come associare un principale a un portafoglio

L’esempio associate-principal-with-portfolio seguente associa un utente al portafoglio specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. associate-product-with-portfolio

AWS CLI

Come associare un prodotto a un portafoglio

L’esempio associate-product-with-portfolio seguente associa il prodotto indicato al portafoglio specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. associate-tag-option-with-resource

AWS CLI

Associare un a TagOption a una risorsa

L'associate-tag-option-with-resourceesempio seguente associa la risorsa specificata TagOption alla risorsa specificata.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. copy-product

AWS CLI

Come copiare un prodotto

L’esempio copy-product seguente crea una copia del prodotto specificato, utilizzando un file JSON per passare i parametri.

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

Contenuto di copy-product-input.json:

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

Output:

{
    "CopyProductToken": "copyproduct-abc5defgjkdji"
}

Il seguente esempio di codice mostra come usare. create-constraint

AWS CLI

Per creare un vincolo

L'create-constraintesempio seguente crea un vincolo.

aws servicecatalog create-constraint \
    --portfolio-id port-y3fnkesxxxxx \
    --product-id prod-cfrfxmraxxxxx \
    --type LAUNCH \
    --parameters '{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}'

Output:

{
    "ConstraintDetail": {
        "ConstraintId": "cons-7tr6gei4bxxxx",
        "Type": "LAUNCH",
        "Owner": "123456789012",
        "ProductId": "prod-cfrfxmra3xxxx",
        "PortfolioId": "port-y3fnkeslpxxxx"
    },
    "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
    "Status": "CREATING"
}

Per ulteriori informazioni, vedere Using AWS Service Catalog Constraints nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. create-portfolio-share

AWS CLI

Come condividere un portafoglio con un account

L’esempio create-portfolio-share seguente condivide il portafoglio specificato con l’account specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. create-portfolio

AWS CLI

Come creare un portafoglio

L’esempio create-portfolio seguente crea un portafoglio.

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

Output:

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

Il seguente esempio di codice mostra come usare. create-product

AWS CLI

Come creare un prodotto

L’esempio create-product seguente crea un prodotto, utilizzando un file JSON per passare i parametri.

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

Contenuto di 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"
    }
}

Output:

{
    "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"
    }
}

Il seguente esempio di codice mostra come usare. create-provisioned-product-plan

AWS CLI

Per creare un piano

L'create-provisioned-product-planesempio seguente crea un piano.

aws servicecatalog create-provisioned-product-plan \
    --plan-name test-plan \
    --plan-type CLOUDFORMATION \
    --product-id prod-cfrfxmraxxxxx \
    --provisioned-product-name test-pp \
    --provisioning-artifact-id pa-7wz4cu5cxxxxx

Output:

{
    "PlanName": "test-plan",
    "PlanId": "plan-cuxae3z6gxxxx",
    "ProvisionProductId": "pp-7kh7wbc4xxxxx",
    "ProvisionedProductName": "test-pp",
    "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx"
}

Per ulteriori informazioni, vedere Creazione di un piano di lancio nella Guida per l'utente di AWS Service Catalog.

Il seguente esempio di codice mostra come usare. create-provisioning-artifact

AWS CLI

Come creare un artefatto di provisioning

L’esempio create-provisioning-artifact seguente crea un artefatto di provisioning, utilizzando un file JSON per passare i parametri.

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

Contenuto di 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"
    }
}

Output:

{
    "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
    }
}

Il seguente esempio di codice mostra come usare. create-tag-option

AWS CLI

Per creare un TagOption

L'create-tag-optionesempio seguente crea un TagOption.

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

Output:

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

  • Per i dettagli sull'API, vedere CreateTagOptionin AWS CLI Command Reference.

Il seguente esempio di codice mostra come usare. delete-constraint

AWS CLI

Per eliminare un vincolo

L'delete-constraintesempio seguente elimina un vincolo.

aws servicecatalog delete-constraint \
    --id cons-7tr6gei4bxxxx

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Using AWS Service Catalog Constraints nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. delete-portfolio-share

AWS CLI

Come arrestare la condivisione di un portafoglio con un account

L’esempio delete-portfolio-share seguente interrompe la condivisione del portafoglio con l’account specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. delete-portfolio

AWS CLI

Come eliminare un portafoglio

L’esempio delete-portfolio seguente elimina il portafoglio specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. delete-product

AWS CLI

Come eliminare un prodotto

L’esempio delete-product seguente elimina il prodotto specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come utilizzare. delete-provisioned-product-plan

AWS CLI

Per eliminare un piano di prodotto fornito

L'delete-provisioned-product-planesempio seguente elimina un piano di prodotto fornito.

aws servicecatalog delete-provisioned-product-plan \
    --plan-id plan-cuxae3z6gxxxx

Questo comando non produce alcun output.

Per ulteriori informazioni, vedere Creazione di un piano di lancio nella Guida per l'utente di AWS Service Catalog.

Il seguente esempio di codice mostra come usare. delete-provisioning-artifact

AWS CLI

Come eliminare un artefatto di provisioning

L’esempio delete-provisioning-artifact seguente elimina l’artefatto di provisioning specificato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. delete-tag-option

AWS CLI

Per eliminare un TagOption

L'delete-tag-optionesempio seguente elimina il valore specificato TagOption.

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

Questo comando non produce alcun output.

  • Per i dettagli sull'API, vedere DeleteTagOptionin AWS CLI Command Reference.

Il seguente esempio di codice mostra come usare. describe-constraint

AWS CLI

Per descrivere un vincolo

L'describe-constraintesempio seguente descrive un vincolo.

aws servicecatalog describe-constraint \
    --id "cons-oqp52evr4bxxxx"

Output:

{
    "ConstraintDetail": {
        "ConstraintId": "cons-7tr6gei4bxxxx",
        "Type": "LAUNCH",
        "Owner": "123456789012",
        "ProductId": "prod-cfrfxmra3xxxx",
        "PortfolioId": "port-y3fnkeslpxxxx"
    },
    "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
    "Status": "AVAILABLE"
}

Per ulteriori informazioni, vedere Using AWS Service Catalog Constraints nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. describe-copy-product-status

AWS CLI

Come descrivere lo stato dell’operazione di copia del prodotto

L’esempio describe-copy-product-status seguente mostra lo stato corrente dell’operazione di copia asincrona del prodotto specificata.

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

Output:

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

Il seguente esempio di codice mostra come usare. describe-portfolio-share-status

AWS CLI

Per descrivere lo stato delle quote di portafoglio

L'describe-portfolio-share-statusesempio seguente descrive lo stato delle azioni di portafoglio.

aws servicecatalog describe-portfolio-share-status \
    --portfolio-share-token "share-agngcybu4xxxx"

Output:

{
    "PortfolioShareToken": "share-agngcybu4xxxx",
    "PortfolioId": "port-y3fnkeslxxxxx",
    "OrganizationNodeValue": "123456789012",
    "Status": "COMPLETED",
    "ShareDetails": {
        "SuccessfulShares": [
            "012345678901"
        ],
        "ShareErrors": []
    }
}

Per ulteriori informazioni, vedere Sharing a Portfolio nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. describe-portfolio-shares

AWS CLI

Per descrivere le azioni del portafoglio

L'describe-portfolio-sharesesempio seguente descrive le azioni di portafoglio.

aws servicecatalog describe-portfolio-shares \
    --portfolio-id port-y3fnkeslxxxxx \
    --type ACCOUNT

Output:

{
    "PortfolioShareDetails": [
        {
            "PrincipalId": "123456789012",
            "Type": "ACCOUNT",
            "Accepted": true,
            "ShareTagOptions": false,
            "SharePrincipals": false
        },
        {
            "PrincipalId": "123456789012",
            "Type": "ACCOUNT",
            "Accepted": false,
            "ShareTagOptions": false,
            "SharePrincipals": false
        }
    ]
}

Per ulteriori informazioni, vedere Sharing a Portfolio nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. describe-portfolio

AWS CLI

Come descrivere un portafoglio

L’esempio describe-portfolio seguente mostra i dettagli del portafoglio specificato.

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

Output:

{
    "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": []
}

Il seguente esempio di codice mostra come usare. describe-product-as-admin

AWS CLI

Come descrivere un prodotto come amministratore

L’esempio describe-product-as-admin seguente mostra i dettagli del prodotto specificato utilizzando privilegi da amministratore.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. describe-product

AWS CLI

Per descrivere un prodotto

L'describe-productesempio seguente descrive un prodotto.

aws servicecatalog describe-product \
    --id prod-dybl43puxxxxx

Output:

{
    "ProductViewSummary": {
        "Id": "prodview-vkvy2kum5xxxx",
        "ProductId": "prod-dybl43puxxxxx",
        "Name": "ec2-test",
        "Owner": "user",
        "ShortDescription": "",
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "Distributor": "",
        "HasDefaultPath": false,
        "SupportEmail": "",
        "SupportDescription": "",
        "SupportUrl": ""
    },
    "ProvisioningArtifacts": [
        {
            "Id": "pa-j7fs6ybztxxxx",
            "Name": "v2",
            "Description": "",
            "CreatedTime": "2021-07-16T15:20:24-05:00",
            "Guidance": "DEFAULT"
        },
        {
            "Id": "pa-s6z7i2nivxxxx",
            "Description": "Create EC2 and KMS",
            "CreatedTime": "2024-06-13T18:27:54-05:00",
            "Guidance": "DEFAULT"
        },
        {
            "Id": "pa-6573v3bloxxxx",
            "Name": "v3",
            "CreatedTime": "2024-06-13T18:45:14-05:00",
            "Guidance": "DEFAULT"
        }
    ],
    "Budgets": [],
    "LaunchPaths": [
        {
            "Id": "lpv3-y3fnkeslpxxxx",
            "Name": "TestPort"
        }
    ]
}

Per ulteriori informazioni, vedere Managing Products nella AWS Service Catalog User Guide.

  • Per i dettagli sull'API, vedere DescribeProductin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzare. describe-provisioned-product-plan

AWS CLI

Per descrivere un piano di prodotto fornito

L'describe-provisioned-product-planesempio seguente descrive un piano di prodotto fornito.

aws servicecatalog describe-provisioned-product-plan \
    --plan-id "plan-g7iwsaf3mxxxx"

Output:

{
    "ProvisionedProductPlanDetails": {
        "CreatedTime": "2025-11-09T18:09:37.808000-06:00",
        "PathId": "lpv3-y3fnkeslpxxxx",
        "ProductId": "prod-cfrfxmraxxxxx",
        "PlanName": "test-plan",
        "PlanId": "plan-g7iwsaf3mxxxx",
        "ProvisionProductId": "pp-mkbnbztzxxxxx",
        "ProvisionProductName": "test-pp",
        "PlanType": "CLOUDFORMATION",
        "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx",
        "Status": "CREATE_SUCCESS",
        "UpdatedTime": "2025-11-09T18:09:46.524000-06:00",
        "Tags": []
    }
}

Per ulteriori informazioni, vedere Creazione di un piano di lancio nella Guida per l'utente di AWS Service Catalog.

Il seguente esempio di codice mostra come usare. describe-provisioned-product

AWS CLI

Come descrivere un prodotto sottoposto a provisioning

L’esempio describe-provisioned-product seguente mostra i dettagli del prodotto sottoposto a provisioning specificato.

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

Output:

{
    "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": []
}

Il seguente esempio di codice mostra come usare. describe-provisioning-artifact

AWS CLI

Come descrivere un artefatto di provisioning

L’esempio describe-provisioning-artifact seguente mostra i dettagli dell’artefatto sottoposto a provisioning specificato.

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

Output:

{
    "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"
}

Il seguente esempio di codice mostra come usare. describe-provisioning-parameters

AWS CLI

Per descrivere i parametri di provisioning

L'describe-provisioning-parametersesempio seguente descrive i parametri di provisioning.

aws servicecatalog describe-provisioning-parameters \
    --product-id prod-cfrfxmraxxxxx \
    --provisioning-artifact-id pa-7wz4cu5cxxxxx \
    --path-id lpv3-y3fnkeslpxxxx

Output:

{
    "ProvisioningArtifactParameters": [
        {
            "ParameterKey": "Size",
            "ParameterType": "String",
            "IsNoEcho": false,
            "ParameterConstraints": {
                "AllowedValues": []
            }
        }
    ],
    "ConstraintSummaries": [
        {
            "Type": "LAUNCH"
        }
    ],
    "UsageInstructions": [
        {
            "Type": "rules",
            "Value": "{}"
        },
        {
            "Type": "version",
            "Value": "2010-09-09"
        },
        {
            "Type": "launchAsRole",
            "Value": "arn:aws:iam::123456789012:role/NewLaunchRole"
        },
        {
            "Type": "tagUpdateOnProvisionedProduct",
            "Value": "NOT_ALLOWED"
        }
    ],
    "TagOptions": [
        {
            "Key": "Application Name",
            "Values": [
                "Testing Tag",
                "Testing Tag Options"
            ]
        }
    ],
    "ProvisioningArtifactPreferences": {},
    "ProvisioningArtifactOutputs": [
        {
            "Key": "pa-7wz4cu5cxxxxx",
            "Description": ""
        }
    ],
    "ProvisioningArtifactOutputKeys": []
}

Per ulteriori informazioni, vedere Launching a product nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. describe-tag-option

AWS CLI

Per descrivere un TagOption

L'describe-tag-optionesempio seguente visualizza i dettagli relativi a quanto specificato TagOption.

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

Output:

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

Il seguente esempio di codice mostra come usare. disassociate-principal-from-portfolio

AWS CLI

Come annullare l’associazione di un principale a un portafoglio

L’esempio disassociate-principal-from-portfolio seguente annulla l’associazione del principale specificato al portafoglio.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. disassociate-product-from-portfolio

AWS CLI

Come annullare l’associazione di un prodotto a un portafoglio

L’esempio disassociate-product-from-portfolio seguente annulla l’associazione del prodotto specificato al portafoglio.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. disassociate-tag-option-from-resource

AWS CLI

Dissociare un TagOption da una risorsa

L’esempio disassociate-tag-option-from-resource seguente annulla l’associazione del TagOption specificato al portafoglio.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. list-accepted-portfolio-shares

AWS CLI

Come elencare le condivisioni di portafoglio accettate

L’esempio list-accepted-portfolio-shares seguente elenca tutti i portafogli per i quali la condivisione è stata accettata da questo account, includendo solo i portafogli predefiniti di Catalogo dei servizi.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. list-constraints-for-portfolio

AWS CLI

Esempio 1: Per elencare tutti i vincoli per un portfolio

L'list-constraints-for-portfolioesempio seguente elenca tutti i vincoli per un portfolio.

aws servicecatalog list-constraints-for-portfolio \
    --portfolio-id port-y3fnkeslpxxxx

Output:

{
    "ConstraintDetails": [
        {
            "ConstraintId": "cons-dgdyqdqrxxxxx",
            "Type": "LAUNCH",
            "Description": "Launch as local role TestLaunchRole",
            "Owner": "123456789012",
            "ProductId": "prod-j6pd3hf6xxxxx",
            "PortfolioId": "port-y3fnkeslxxxxx"
        },
        {
            "ConstraintId": "cons-tzxjnj4l6xxxx",
            "Type": "RESOURCE_UPDATE",
            "Owner": "123456789012",
            "ProductId": "prod-sphewkokxxxxx",
            "PortfolioId": "port-y3fnkeslxxxxx"
        }
    ]
}

Esempio 2: elencare i vincoli relativi a un prodotto

L'list-constraints-for-portfolioesempio seguente elenca i vincoli relativi a un prodotto.

aws servicecatalog list-constraints-for-portfolio \
    --portfolio-id port-y3fnkeslxxxxx \
    --product-id prod-j6pd3hf6xxxxx

Output:

{
    "ConstraintDetails": [
        {
            "ConstraintId": "cons-dgdyqdqrxxxxx",
            "Type": "LAUNCH",
            "Description": "Launch as local role TestLaunchRole",
            "Owner": "123456789012",
            "ProductId": "prod-j6pd3hf6xxxxx",
            "PortfolioId": "port-y3fnkeslxxxxx"
        }
    ]
}

Per ulteriori informazioni, vedere Using AWS Service Catalog Constraints nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. list-launch-paths

AWS CLI

Per elencare i percorsi di avvio

L'list-launch-pathsesempio seguente elenca i percorsi di avvio di un portfolio.

aws servicecatalog list-launch-paths \
    --product-id prod-cfrfxmraxxxxx

Output:

{
    "LaunchPathSummaries": [
        {
            "Id": "lpv3-y3fnkeslpxxxx",
            "ConstraintSummaries": [
                {
                    "Type": "LAUNCH"
                }
            ],
            "Tags": [],
            "Name": "TestPort"
        }
    ]
}

Per ulteriori informazioni, vedere Concessione dell'accesso agli utenti nella Guida per l'utente del AWS Service Catalog.

  • Per i dettagli sull'API, vedere ListLaunchPathsin AWS CLI Command Reference.

Il seguente esempio di codice mostra come usare. list-portfolio-access

AWS CLI

Come elencare gli account con accesso a un portafoglio

L'list-portfolio-accessesempio seguente elenca gli AWS account che hanno accesso al portafoglio specificato.

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

Output:

{
    "AccountIds": [
        "123456789012"
    ]
}

Il seguente esempio di codice mostra come usare. list-portfolios-for-product

AWS CLI

Come elencare i portafogli associati a un prodotto

L’esempio list-portfolios-for-product seguente elenca i portafogli associati al prodotto specificato.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. list-portfolios

AWS CLI

Come elencare i portafogli

L’esempio list-portfolios seguente elenca i portafogli di Catalogo dei servizi presenti nella Regione corrente.

aws servicecatalog list-portfolios

Output:

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

Il seguente esempio di codice mostra come usare. list-principals-for-portfolio

AWS CLI

Come elencare tutti i principali per un portafoglio

L’esempio list-principals-for-portfolio seguente elenca tutti i principali del portafoglio specificato.

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

Output:

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

Il seguente esempio di codice mostra come usare. list-provisioning-artifacts

AWS CLI

Come elencare tutti gli artefatti di provisioning per un prodotto

L’esempio list-provisioning-artifacts seguente elenca tutti gli artefatti di provisioning per il prodotto specificato.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. list-resources-for-tag-option

AWS CLI

Per elencare le risorse associate a TagOption

L’esempio list-resources-for-tag-option seguente elenca le risorse associate al TagOption specificato.

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

Output:

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

Il seguente esempio di codice mostra come usare. list-tag-options

AWS CLI

L’esempio list-tag-options seguente elenca tutti i valori per TagOptions.

aws servicecatalog list-tag-options

Output:

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

Il seguente esempio di codice mostra come usare. provision-product

AWS CLI

Come eseguire il provisioning di un prodotto

L’esempio provision-product seguente esegue il provisioning del prodotto specificato utilizzando l’artefatto di provisioning specificato.

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

Output:

{
    "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"
    }
}

Il seguente esempio di codice mostra come usare. reject-portfolio-share

AWS CLI

Come rifiutare una condivisione di portafoglio

L’esempio reject-portfolio-share seguente rifiuta la condivisione del portafoglio indicato.

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

Questo comando non produce alcun output.

Il seguente esempio di codice mostra come usare. scan-provisioned-products

AWS CLI

Come elencare tutti i prodotti sottoposti a provisioning disponibili

L’esempio scan-provisioned-products seguente elenca i prodotti sottoposti a provisioning disponibili.

aws servicecatalog scan-provisioned-products

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. search-products-as-admin

AWS CLI

Come cercare prodotti con privilegi da amministratore

L’esempio search-products-as-admin seguente cerca prodotti con privilegi da amministratore, utilizzando un ID portafoglio come filtro.

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

Output:

{
    "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"
        }
    ]
}

Il seguente esempio di codice mostra come usare. search-products

AWS CLI

Per ottenere informazioni sui prodotti a cui il chiamante ha accesso

L'search-productsesempio seguente ottiene tutti i prodotti a cui il chiamante ha accesso.

aws servicecatalog search-products

Output:

{
    "ProductViewSummaries": [
        {
            "Id": "prodview-5uksdh4xxxxxx",
            "ProductId": "prod-j6fu3hxxxxxxxx",
            "Name": "TestSC",
            "Owner": "test",
            "ShortDescription": "",
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "Distributor": "",
            "HasDefaultPath": false,
            "SupportEmail": "",
            "SupportDescription": "",
            "SupportUrl": ""
        },
        {
            "Id": "prodview-3kfoaabxxxxxx",
            "ProductId": "prod-j6pd3xxxxxxxx",
            "Name": "TestProduct",
            "Owner": "test_owner",
            "ShortDescription": "",
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "Distributor": "",
            "HasDefaultPath": false,
            "SupportEmail": "",
            "SupportDescription": "",
            "SupportUrl": ""
        }
    ]
}

Per ulteriori informazioni, vedere Managing Products nella AWS Service Catalog User Guide.

  • Per i dettagli sull'API, vedere SearchProductsin AWS CLI Command Reference.

Il seguente esempio di codice mostra come usare. search-provisioned-products

AWS CLI

Come cercare i prodotti sottoposti a provisioning

L’esempio search-provisioned-products seguente cerca i prodotti sottoposti a provisioning corrispondenti all’ID prodotto specificato, utilizzando un file JSON per passare i parametri.

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

Contenuto di search-provisioned-products-input.json:

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

Output:

{
    "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
}

Il seguente esempio di codice mostra come usare. terminate-provisioned-product

AWS CLI

Per terminare un prodotto fornito

L'terminate-provisioned-productesempio seguente termina un prodotto fornito.

aws servicecatalog terminate-provisioned-product \
    --provisioned-product-id pp-7z4t3k4hxxxxx

Output:

{
    "RecordDetail": {
        "RecordId": "rec-sbwnhzld3xxxx",
        "ProvisionedProductName": "test2",
        "Status": "CREATED",
        "CreatedTime": "2025-12-31T15:23:55.051000-06:00",
        "UpdatedTime": "2025-12-31T15:23:55.051000-06:00",
        "ProvisionedProductType": "CFN_STACK",
        "RecordType": "TERMINATE_PROVISIONED_PRODUCT",
        "ProvisionedProductId": "pp-7z4t3k4hxxxxx",
        "ProductId": "prod-j6pd3hf6xxxxx",
        "ProvisioningArtifactId": "pa-sbhovlh7wxxxx",
        "PathId": "lpv3-y3fnkeslpxxxx",
        "RecordErrors": [],
        "RecordTags": [],
        "LaunchRoleArn": "arn:aws:iam::123456789012:role/TestLaunchRole"
    }
}

Per ulteriori informazioni, vedere Managing Provisioned Products nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. update-constraint

AWS CLI

Per aggiornare un vincolo

L'update-constraintesempio seguente aggiorna un vincolo.

aws servicecatalog update-constraint \
    --id cons-dgdyqdqrxxxxx \
    --parameters '{"LocalRoleName": "TestLaunchRole"}'

Output:

{
    "ConstraintDetail": {
        "ConstraintId": "cons-dgdyqdqrxxxxx",
        "Type": "LAUNCH",
        "Description": "Launch as local role TestLaunchRole",
        "Owner": "123456789012",
        "ProductId": "prod-j6pd3hf6xxxxx",
        "PortfolioId": "port-y3fnkeslxxxxx"
    },
    "ConstraintParameters": "{\"LocalRoleName\": \"TestLaunchRole\"}",
    "Status": "CREATING"
}

Per ulteriori informazioni, vedere Using AWS Service Catalog Constraints nella AWS Service Catalog User Guide.

Il seguente esempio di codice mostra come usare. update-portfolio

AWS CLI

Come aggiornare un portafoglio

L’esempio update-portfolio seguente aggiorna il nome del portafoglio specificato.

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

Output:

{
    "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": []
}

Il seguente esempio di codice mostra come usare. update-product

AWS CLI

Come aggiornare un prodotto

L’esempio update-product seguente aggiorna il nome e il proprietario del prodotto specificato.

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

Output:

{
    "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
    }
}

Il seguente esempio di codice mostra come usare. update-provisioning-artifact

AWS CLI

Come aggiornare un artefatto di provisioning

L’esempio update-provisioning-artifact seguente aggiorna il nome e la descrizione dell’artefatto di provisioning specificato, utilizzando un file JSON per passare i parametri.

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

Contenuto di update-provisioning-artifact-input.json:

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

Output:

{
    "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
    }
}

Il seguente esempio di codice mostra come usare. update-tag-option

AWS CLI

Per aggiornare un TagOption

L’esempio update-tag-option seguente aggiorna il valore di un TagOption, utilizzando il file JSON specificato.

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

Contenuto di update-tag-option-input.json:

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

Output:

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