# Exemplos do Service Catalog usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Service Catalog.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `accept-portfolio-share`
O código de exemplo a seguir mostra como usar `accept-portfolio-share`.
**AWS CLI**
**Para aceitar o compartilhamento de um portfólio**
O exemplo `accept-portfolio-share` a seguir aceita uma oferta, feita por outro usuário, para compartilhar o portfólio especificado.
```
aws servicecatalog accept-portfolio-share \
--portfolio-id port-2s6wuabcdefghijk
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AcceptPortfolioShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/accept-portfolio-share.html) na *Referência de comandos da AWS CLI*.
### `associate-principal-with-portfolio`
O código de exemplo a seguir mostra como usar `associate-principal-with-portfolio`.
**AWS CLI**
**Como associar uma entidade principal a um portfólio**
O exemplo `associate-principal-with-portfolio` a seguir associa um usuário ao portfólio especificado.
```
aws servicecatalog associate-principal-with-portfolio \
--portfolio-id port-2s6abcdefwdh4 \
--principal-arn arn:aws:iam::123456789012:user/usertest \
--principal-type IAM
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AssociatePrincipalWithPortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/associate-principal-with-portfolio.html) na *Referência de comandos da AWS CLI*.
### `associate-product-with-portfolio`
O código de exemplo a seguir mostra como usar `associate-product-with-portfolio`.
**AWS CLI**
**Como associar um produto a um portfólio**
O exemplo `associate-product-with-portfolio` a seguir associa o produto especificado ao portfólio especificado.
```
aws servicecatalog associate-product-with-portfolio
--product-id prod-3p5abcdef3oyk
--portfolio-id port-2s6abcdef5wdh4
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AssociateProductWithPortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/associate-product-with-portfolio.html) na *Referência de comandos da AWS CLI*.
### `associate-tag-option-with-resource`
O código de exemplo a seguir mostra como usar `associate-tag-option-with-resource`.
**AWS CLI**
**Como associar uma TagOption a um recurso**
O exemplo `associate-tag-option-with-resource` a seguir associa a TagOption especificada ao recurso especificado.
```
aws servicecatalog associate-tag-option-with-resource \
--resource-id port-2s6abcdq5wdh4 \
--tag-option-id tag-p3abc2pkpz5qc
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AssociateTagOptionWithResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/associate-tag-option-with-resource.html) na *Referência de comandos da AWS CLI*.
### `copy-product`
O código de exemplo a seguir mostra como usar `copy-product`.
**AWS CLI**
**Como copiar um produto**
O exemplo `copy-product` a seguir faz uma cópia do produto especificado usando um arquivo JSON para transmitir parâmetros.
```
aws servicecatalog copy-product --cli-input-json file://copy-product-input.json
```
Conteúdo de `copy-product-input.json`:
```
{
"SourceProductArn": "arn:aws:catalog:us-west-2:123456789012:product/prod-tcabcd3syn2xy",
"TargetProductName": "copy-of-myproduct",
"CopyOptions": [
"CopyTags"
]
}
```
Resultado:
```
{
"CopyProductToken": "copyproduct-abc5defgjkdji"
}
```
+ Para ver detalhes da API, consulte [CopyProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/copy-product.html) na *Referência de comandos da AWS CLI*.
### `create-portfolio-share`
O código de exemplo a seguir mostra como usar `create-portfolio-share`.
**AWS CLI**
**Como compartilhar um portfólio com uma conta**
O exemplo `create-portfolio-share` a seguir compartilha o portfólio especificado com a conta especificada.
```
aws servicecatalog create-portfolio-share \
--portfolio-id port-2s6abcdef5wdh4 \
--account-id 794123456789
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [CreatePortfolioShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/create-portfolio-share.html) na *Referência de comandos da AWS CLI*.
### `create-portfolio`
O código de exemplo a seguir mostra como usar `create-portfolio`.
**AWS CLI**
**Para criar um portfólio**
O exemplo `create-portfolio` a seguir cria um portfólio.
```
aws servicecatalog create-portfolio \
--provider-name my-provider \
--display-name my-portfolio
```
Resultado:
```
{
"PortfolioDetail": {
"ProviderName": "my-provider",
"DisplayName": "my-portfolio",
"CreatedTime": 1571337221.555,
"ARN": "arn:aws:catalog:us-east-2:123456789012:portfolio/port-2s6xmplq5wdh4",
"Id": "port-2s6xmplq5wdh4"
}
}
```
+ Para ver detalhes da API, consulte [CreatePortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/create-portfolio.html) na *Referência de comandos da AWS CLI*.
### `create-product`
O código de exemplo a seguir mostra como usar `create-product`.
**AWS CLI**
**Para criar um produto**
O exemplo `create-product` a seguir cria um produto usando um arquivo JSON para transmitir parâmetros.
```
aws servicecatalog create-product \
--cli-input-json file://create-product-input.json
```
Conteúdo 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"
}
}
```
Resultado:
```
{
"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"
}
}
```
+ Para ver detalhes da API, consulte [CreateProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/create-product.html) na *Referência de comandos da AWS CLI*.
### `create-provisioning-artifact`
O código de exemplo a seguir mostra como usar `create-provisioning-artifact`.
**AWS CLI**
**Para criar um artefato de provisionamento**
O exemplo `create-provisioning-artifact` a seguir cria um artefato de provisionamento usando um arquivo JSON para transmitir parâmetros.
```
aws servicecatalog create-provisioning-artifact \
--cli-input-json file://create-provisioning-artifact-input.json
```
Conteúdo 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"
}
}
```
Resultado:
```
{
"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
}
}
```
+ Para ver detalhes da API, consulte [CreateProvisioningArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/create-provisioning-artifact.html) na *Referência de comandos da AWS CLI*.
### `create-tag-option`
O código de exemplo a seguir mostra como usar `create-tag-option`.
**AWS CLI**
**Para criar uma TagOption**
O exemplo `create-tag-option` a seguir cria uma TagOption.
```
aws servicecatalog create-tag-option
--key 1234
--value name
```
Resultado:
```
{
"TagOptionDetail": {
"Id": "tag-iabcdn4fzjjms",
"Value": "name",
"Active": true,
"Key": "1234"
}
}
```
+ Para ver detalhes da API, consulte [CreateTagOption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/create-tag-option.html) na *Referência de comandos da AWS CLI*.
### `delete-portfolio-share`
O código de exemplo a seguir mostra como usar `delete-portfolio-share`.
**AWS CLI**
**Como interromper o compartilhamento de um portfólio com uma conta**
O exemplo `delete-portfolio-share` a seguir interrompe o compartilhamento do portfólio com a conta especificada.
```
aws servicecatalog delete-portfolio-share \
--portfolio-id port-2s6abcdq5wdh4 \
--account-id 123456789012
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeletePortfolioShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/delete-portfolio-share.html) na *Referência de comandos da AWS CLI*.
### `delete-portfolio`
O código de exemplo a seguir mostra como usar `delete-portfolio`.
**AWS CLI**
**Para excluir um portfólio**
O exemplo `delete-portfolio` a seguir exclui o portfólio especificado.
```
aws servicecatalog delete-portfolio \
--id port-abcdlx4gox4do
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeletePortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/delete-portfolio.html) na *Referência de comandos da AWS CLI*.
### `delete-product`
O código de exemplo a seguir mostra como usar `delete-product`.
**AWS CLI**
**Para excluir um produto**
O exemplo `delete-product` a seguir exclui o produto especificado.
```
aws servicecatalog delete-product \
--id prod-abcdcek6yhbxi
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeleteProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/delete-product.html) na *Referência de comandos da AWS CLI*.
### `delete-provisioning-artifact`
O código de exemplo a seguir mostra como usar `delete-provisioning-artifact`.
**AWS CLI**
**Para excluir um artefato de provisionamento**
O exemplo `delete-provisioning-artifact` a seguir excluir o artefato de provisionamento especificado.
```
aws servicecatalog delete-provisioning-artifact \
--product-id prod-abc2uebuplcpw \
--provisioning-artifact-id pa-pqabcddii7ouc
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeleteProvisioningArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/delete-provisioning-artifact.html) na *Referência de comandos da AWS CLI*.
### `delete-tag-option`
O código de exemplo a seguir mostra como usar `delete-tag-option`.
**AWS CLI**
**Para excluir uma TagOption**
O exemplo `delete-tag-option` a seguir exclui a TagOption especificada.
```
aws servicecatalog delete-tag-option \
--id tag-iabcdn4fzjjms
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeleteTagOption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/delete-tag-option.html) na *Referência de comandos da AWS CLI*.
### `describe-copy-product-status`
O código de exemplo a seguir mostra como usar `describe-copy-product-status`.
**AWS CLI**
**Para descrever o status da operação do produto de cópia**
O exemplo `describe-copy-product-status` a seguir exibe o status atual da operação do produto de cópia assíncrona especificado.
```
aws servicecatalog describe-copy-product-status \
--copy-product-token copyproduct-znn5tf5abcd3w
```
Resultado:
```
{
"CopyProductStatus": "SUCCEEDED",
"TargetProductId": "prod-os6hog7abcdt2"
}
```
+ Para ver detalhes da API, consulte [DescribeCopyProductStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-copy-product-status.html) na *Referência de comandos da AWS CLI*.
### `describe-portfolio`
O código de exemplo a seguir mostra como usar `describe-portfolio`.
**AWS CLI**
**Para descrever um portfólio**
O exemplo `describe-portfolio` a seguir exibe os detalhes do portfólio especificado.
```
aws servicecatalog describe-portfolio \
--id port-2s6abcdq5wdh4
```
Resultado:
```
{
"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": []
}
```
+ Para ver detalhes da API, consulte [DescribePortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-portfolio.html) na *Referência de comandos da AWS CLI*.
### `describe-product-as-admin`
O código de exemplo a seguir mostra como usar `describe-product-as-admin`.
**AWS CLI**
**Para descrever um produto como um administrador**
O exemplo `describe-product-as-admin` a seguir exibe os detalhes do produto especificado usando os privilégios de administrador.
```
aws servicecatalog describe-product-as-admin \
--id prod-abcdcek6yhbxi
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [DescribeProductAsAdmin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-product-as-admin.html) na *Referência de comandos da AWS CLI*.
### `describe-provisioned-product`
O código de exemplo a seguir mostra como usar `describe-provisioned-product`.
**AWS CLI**
**Para descrever um produto provisionado**
O exemplo `describe-provisioned-product` a seguir exibe os detalhes do produto provisionado especificado.
```
aws servicecatalog describe-provisioned-product \
--id pp-dpom27bm4abcd
```
Resultado:
```
{
"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": []
}
```
+ Para ver detalhes da API, consulte [DescribeProvisionedProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-provisioned-product.html) na *Referência de comandos da AWS CLI*.
### `describe-provisioning-artifact`
O código de exemplo a seguir mostra como usar `describe-provisioning-artifact`.
**AWS CLI**
**Para descrever um artefato de provisionamento**
O exemplo `describe-provisioning-artifact` a seguir exibe detalhes do artefato de provisionamento especificado.
```
aws servicecatalog describe-provisioning-artifact \
--provisioning-artifact-id pa-pcz347abcdcfm \
--product-id prod-abcdfz3syn2rg
```
Resultado:
```
{
"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"
}
```
+ Para ver detalhes da API, consulte [DescribeProvisioningArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-provisioning-artifact.html) na *Referência de comandos da AWS CLI*.
### `describe-tag-option`
O código de exemplo a seguir mostra como usar `describe-tag-option`.
**AWS CLI**
**Para descrever uma TagOption**
O exemplo `describe-tag-option` a seguir exibe os detalhes da TagOption especificada.
```
aws servicecatalog describe-tag-option \
--id tag-p3tej2abcd5qc
```
Resultado:
```
{
"TagOptionDetail": {
"Active": true,
"Id": "tag-p3tej2abcd5qc",
"Value": "value-3",
"Key": "1234"
}
}
```
+ Para ver detalhes da API, consulte [DescribeTagOption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/describe-tag-option.html) na *Referência de comandos da AWS CLI*.
### `disassociate-principal-from-portfolio`
O código de exemplo a seguir mostra como usar `disassociate-principal-from-portfolio`.
**AWS CLI**
**Para desassociar uma entidade principal de um portfólio**
O exemplo `disassociate-principal-from-portfolio` a seguir desassocia a entidade principal especificada do portfólio.
```
aws servicecatalog disassociate-principal-from-portfolio \
--portfolio-id port-2s6abcdq5wdh4 \
--principal-arn arn:aws:iam::123456789012:group/myendusers
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DisassociatePrincipalFromPortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/disassociate-principal-from-portfolio.html) na *Referência de comandos da AWS CLI*.
### `disassociate-product-from-portfolio`
O código de exemplo a seguir mostra como usar `disassociate-product-from-portfolio`.
**AWS CLI**
**Para desassociar um produto de um portfólio**
O exemplo `disassociate-product-from-portfolio` a seguir desassocia o produto especificado do portfólio.
```
aws servicecatalog disassociate-product-from-portfolio \
--product-id prod-3p5abcdmu3oyk \
--portfolio-id port-2s6abcdq5wdh4
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DisassociateProductFromPortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/disassociate-product-from-portfolio.html) na *Referência de comandos da AWS CLI*.
### `disassociate-tag-option-from-resource`
O código de exemplo a seguir mostra como usar `disassociate-tag-option-from-resource`.
**AWS CLI**
**Para desassociar uma TagOption de um recurso**
O exemplo `disassociate-tag-option-from-resource` a seguir desassocia o `TagOption` especificado do recurso.
```
aws servicecatalog disassociate-tag-option-from-resource \
--resource-id port-2s6abcdq5wdh4 \
--tag-option-id tag-p3abc2pkpz5qc
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DisassociateTagOptionFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/disassociate-tag-option-from-resource.html) na *Referência de comandos da AWS CLI*.
### `list-accepted-portfolio-shares`
O código de exemplo a seguir mostra como usar `list-accepted-portfolio-shares`.
**AWS CLI**
**Para listar compartilhamentos de portfólio aceitos**
O exemplo `list-accepted-portfolio-shares` a seguir lista todos os portfólios nos quais o compartilhamento foi aceito por essa conta, incluindo somente os portfólios padrão do Service Catalog.
```
aws servicecatalog list-accepted-portfolio-shares \
--portfolio-share-type "AWS_SERVICECATALOG"
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [ListAcceptedPortfolioShares](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-accepted-portfolio-shares.html) na *Referência de comandos da AWS CLI*.
### `list-portfolio-access`
O código de exemplo a seguir mostra como usar `list-portfolio-access`.
**AWS CLI**
**Para listar contas com acesso a um portfólio**
O exemplo `list-portfolio-access` a seguir lista as contas da AWS que têm acesso ao portfólio especificado.
```
aws servicecatalog list-portfolio-access \
--portfolio-id port-2s6abcdq5wdh4
```
Resultado:
```
{
"AccountIds": [
"123456789012"
]
}
```
+ Para ver detalhes da API, consulte [ListPortfolioAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-portfolio-access.html) na *Referência de comandos da AWS CLI*.
### `list-portfolios-for-product`
O código de exemplo a seguir mostra como usar `list-portfolios-for-product`.
**AWS CLI**
**Para listar portfólios associados a um produto**
O exemplo `list-portfolios-for-product` a seguir lista os portfólios associados ao produto especificado.
```
aws servicecatalog list-portfolios-for-product \
--product-id prod-abcdfz3syn2rg
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [ListPortfoliosForProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-portfolios-for-product.html) na *Referência de comandos da AWS CLI*.
### `list-portfolios`
O código de exemplo a seguir mostra como usar `list-portfolios`.
**AWS CLI**
**Para listar portfólios**
O exemplo `list-portfolios` a seguir lista os portfólios do Service Catalog na região atual.
```
aws servicecatalog list-portfolios
```
Resultado:
```
{
"PortfolioDetails": [
{
"CreatedTime": 1559665256.348,
"ARN": "arn:aws:catalog:us-east-2:123456789012:portfolio/port-5pzcxmplst4ei",
"DisplayName": "my-portfolio",
"Id": "port-5pzcxmplst4ei",
"ProviderName": "my-user"
}
]
}
```
+ Para ver detalhes da API, consulte [ListPortfolios](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-portfolios.html) na *Referência de comandos da AWS CLI*.
### `list-principals-for-portfolio`
O código de exemplo a seguir mostra como usar `list-principals-for-portfolio`.
**AWS CLI**
**Para listar todas as entidades principais de um portfólio**
O exemplo `list-principals-for-portfolio` a seguir lista todas as entidades principais do portfólio especificado.
```
aws servicecatalog list-principals-for-portfolio \
--portfolio-id port-2s6abcdq5wdh4
```
Resultado:
```
{
"Principals": [
{
"PrincipalARN": "arn:aws:iam::123456789012:user/usertest",
"PrincipalType": "IAM"
}
]
}
```
+ Para ver detalhes da API, consulte [ListPrincipalsForPortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-principals-for-portfolio.html) na *Referência de comandos da AWS CLI*.
### `list-provisioning-artifacts`
O código de exemplo a seguir mostra como usar `list-provisioning-artifacts`.
**AWS CLI**
**Para listar todos os artefatos de provisionamento de um produto**
O exemplo `list-provisioning-artifacts` a seguir lista todos os artefatos de provisionamento do produto especificado.
```
aws servicecatalog list-provisioning-artifacts \
--product-id prod-nfi2abcdefgcpw
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [ListProvisioningArtifacts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-provisioning-artifacts.html) na *Referência de comandos da AWS CLI*.
### `list-resources-for-tag-option`
O código de exemplo a seguir mostra como usar `list-resources-for-tag-option`.
**AWS CLI**
**Para listar recursos associados a uma TagOption**
O exemplo `list-resources-for-tag-option` a seguir lista os recursos associados à `TagOption` especificada.
```
aws servicecatalog list-resources-for-tag-option \
--tag-option-id tag-p3tej2abcd5qc
```
Resultado:
```
{
"ResourceDetails": [
{
"ARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
"Name": "my product",
"Description": "description",
"CreatedTime": 1562097906.0,
"Id": "prod-abcdfz3syn2rg"
}
]
}
```
+ Para ver detalhes da API, consulte [ListResourcesForTagOption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-resources-for-tag-option.html) na *Referência de comandos da AWS CLI*.
### `list-tag-options`
O código de exemplo a seguir mostra como usar `list-tag-options`.
**AWS CLI**
O exemplo `list-tag-options` a seguir lista todos os valores da `TagOptions`.
```
aws servicecatalog list-tag-options
```
Resultado:
```
{
"TagOptionDetails": [
{
"Value": "newvalue",
"Active": true,
"Id": "tag-iabcdn4fzjjms",
"Key": "1234"
},
{
"Value": "value1",
"Active": true,
"Id": "tag-e3abcdvmwvrzy",
"Key": "key"
}
]
}
```
+ Para ver detalhes da API, consulte [ListTagOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/list-tag-options.html) na *Referência de comandos da AWS CLI*.
### `provision-product`
O código de exemplo a seguir mostra como usar `provision-product`.
**AWS CLI**
**Como provisionar um produto**
O exemplo `provision-product` a seguir provisiona o produto especificado usando o artefato de provisionamento especificado.
```
aws servicecatalog provision-product \
--product-id prod-abcdfz3syn2rg \
--provisioning-artifact-id pa-abc347pcsccfm \
--provisioned-product-name "mytestppname3"
```
Resultado:
```
{
"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"
}
}
```
+ Para ver detalhes da API, consulte [ProvisionProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/provision-product.html) na *Referência de comandos da AWS CLI*.
### `reject-portfolio-share`
O código de exemplo a seguir mostra como usar `reject-portfolio-share`.
**AWS CLI**
**Como rejeitar o compartilhamento de um portfólio**
O exemplo `reject-portfolio-share` a seguir rejeita o compartilhamento do portfólio em questão.
```
aws servicecatalog reject-portfolio-share \
--portfolio-id port-2s6wuabcdefghijk
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [RejectPortfolioShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/reject-portfolio-share.html) na *Referência de comandos da AWS CLI*.
### `scan-provisioned-products`
O código de exemplo a seguir mostra como usar `scan-provisioned-products`.
**AWS CLI**
**Para listar todos os produtos provisionados disponíveis**
O exemplo `scan-provisioned-products` a seguir lista os produtos provisionados disponíveis.
```
aws servicecatalog scan-provisioned-products
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [ScanProvisionedProducts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/scan-provisioned-products.html) na *Referência de comandos da AWS CLI*.
### `search-products-as-admin`
O código de exemplo a seguir mostra como usar `search-products-as-admin`.
**AWS CLI**
**Como pesquisar produtos com privilégios de administrador**
O exemplo `search-products-as-admin` a seguir pesquisa produtos com privilégios de administrador, usando um ID de portfólio como filtro.
```
aws servicecatalog search-products-as-admin \
--portfolio-id port-5abcd3e5st4ei
```
Resultado:
```
{
"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"
}
]
}
```
+ Para ver detalhes da API, consulte [SearchProductsAsAdmin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/search-products-as-admin.html) na *Referência de comandos da AWS CLI*.
### `search-provisioned-products`
O código de exemplo a seguir mostra como usar `search-provisioned-products`.
**AWS CLI**
**Como pesquisar produtos provisionados**
O exemplo `search-provisioned-products` a seguir pesquisa produtos provisionados que correspondam ao ID do produto especificado usando um arquivo JSON para transmitir parâmetros.
```
aws servicecatalog search-provisioned-products \
--cli-input-json file://search-provisioned-products-input.json
```
Conteúdo de `search-provisioned-products-input.json`:
```
{
"Filters": {
"SearchQuery": [
"prod-tcjvfz3syn2rg"
]
}
}
```
Resultado:
```
{
"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
}
```
+ Para ver detalhes da API, consulte [SearchProvisionedProducts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/search-provisioned-products.html) na *Referência de comandos da AWS CLI*.
### `update-portfolio`
O código de exemplo a seguir mostra como usar `update-portfolio`.
**AWS CLI**
**Para atualizar um portfólio**
O exemplo `update-portfolio` a seguir atualiza o nome do portfólio especificado.
```
aws servicecatalog update-portfolio \
--id port-5abcd3e5st4ei \
--display-name "New portfolio name"
```
Resultado:
```
{
"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": []
}
```
+ Para ver detalhes da API, consulte [UpdatePortfolio](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/update-portfolio.html) na *Referência de comandos da AWS CLI*.
### `update-product`
O código de exemplo a seguir mostra como usar `update-product`.
**AWS CLI**
**Para atualizar um produto**
O exemplo `update-product` a seguir atualiza o nome e o proprietário do produto especificado.
```
aws servicecatalog update-product \
--id prod-os6abc7drqlt2 \
--name "New product name" \
--owner "Updated product owner"
```
Resultado:
```
{
"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
}
}
```
+ Para ver detalhes da API, consulte [UpdateProduct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/update-product.html) na *Referência de comandos da AWS CLI*.
### `update-provisioning-artifact`
O código de exemplo a seguir mostra como usar `update-provisioning-artifact`.
**AWS CLI**
**Para atualizar um artefato de provisionamento**
O exemplo `update-provisioning-artifact` a seguir atualiza o nome e a descrição do artefato de provisionamento especificado usando um arquivo JSON para transmitir parâmetros.
```
aws servicecatalog update-provisioning-artifact \
--cli-input-json file://update-provisioning-artifact-input.json
```
Conteúdo de `update-provisioning-artifact-input.json`:
```
{
"ProductId": "prod-abcdfz3syn2rg",
"ProvisioningArtifactId": "pa-pcz347abcdcfm",
"Name": "updated name",
"Description": "updated description"
}
```
Resultado:
```
{
"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
}
}
```
+ Para ver detalhes da API, consulte [UpdateProvisioningArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/update-provisioning-artifact.html) na *Referência de comandos da AWS CLI*.
### `update-tag-option`
O código de exemplo a seguir mostra como usar `update-tag-option`.
**AWS CLI**
**Para atualizar uma TagOption**
O exemplo `update-tag-option` a seguir atualiza o valor de uma `TagOption` usando o arquivo JSON especificado.
```
aws servicecatalog update-tag-option --cli-input-json file://update-tag-option-input.json
```
Conteúdo de `update-tag-option-input.json`:
```
{
"Id": "tag-iabcdn4fzjjms",
"Value": "newvalue",
"Active": true
}
```
Resultado:
```
{
"TagOptionDetail": {
"Value": "newvalue",
"Key": "1234",
"Active": true,
"Id": "tag-iabcdn4fzjjms"
}
}
```
+ Para ver detalhes da API, consulte [UpdateTagOption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog/update-tag-option.html) na *Referência de comandos da AWS CLI*.