使用 Service Catalog 示例 Amazon CLI

以下代码示例向您展示了如何使用 with Service Catalog 来执行操作和实现常见场景。 Amazon Command Line Interface

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景和跨服务示例的上下文查看操作。

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

操作

以下代码示例演示如何使用 accept-portfolio-share。

Amazon CLI

接受投资组合份额

以下accept-portfolio-share示例接受其他用户提出的共享指定投资组合的提议。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考AcceptPortfolioShare中的。

以下代码示例演示如何使用 associate-principal-with-portfolio。

Amazon CLI

将委托人与投资组合关联起来

以下associate-principal-with-portfolio示例将用户与指定的产品组合相关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考AssociatePrincipalWithPortfolio中的。

以下代码示例演示如何使用 associate-product-with-portfolio。

Amazon CLI

将产品与产品组合关联

以下associate-product-with-portfolio示例将给定产品与指定的产品组合相关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考AssociateProductWithPortfolio中的。

以下代码示例演示如何使用 associate-tag-option-with-resource。

Amazon CLI

将 TagOption 与资源关联

以下associate-tag-option-with-resource示例将指定的 TagOption 与指定的资源相关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考AssociateTagOptionWithResource中的。

以下代码示例演示如何使用 copy-product。

Amazon CLI

复制产品

以下copy-product示例使用 JSON 文件传递参数，创建指定产品的副本。


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

copy-product-input.json 的内容：


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

输出：


{
    "CopyProductToken": "copyproduct-abc5defgjkdji"
}

有关 API 的详细信息，请参阅Amazon CLI 命令参考CopyProduct中的。

以下代码示例演示如何使用 create-portfolio-share。

Amazon CLI

与账户共享投资组合

以下create-portfolio-share示例与指定账户共享指定的投资组合。


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

此命令不产生任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreatePortfolioShare中的。

以下代码示例演示如何使用 create-portfolio。

Amazon CLI

创建投资组合

以下create-portfolio示例创建了一个投资组合。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreatePortfolio中的。

以下代码示例演示如何使用 create-product。

Amazon CLI

创建产品

以下create-product示例使用 JSON 文件传递参数来创建产品。


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

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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateProduct中的。

以下代码示例演示如何使用 create-provisioning-artifact。

Amazon CLI

创建置备对象

以下create-provisioning-artifact示例使用一个 JSON 文件来传递参数来创建配置对象。


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

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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateProvisioningArtifact中的。

以下代码示例演示如何使用 create-tag-option。

Amazon CLI

要创建 TagOption

以下create-tag-option示例创建了一个 TagOption。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateTagOption中的。

以下代码示例演示如何使用 delete-portfolio-share。

Amazon CLI

停止与账户共享投资组合

以下delete-portfolio-share示例停止与指定账户共享投资组合。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeletePortfolioShare中的。

以下代码示例演示如何使用 delete-portfolio。

Amazon CLI

删除投资组合

以下delete-portfolio示例删除了指定的投资组合。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeletePortfolio中的。

以下代码示例演示如何使用 delete-product。

Amazon CLI

删除产品

以下delete-product示例删除了指定的产品。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteProduct中的。

以下代码示例演示如何使用 delete-provisioning-artifact。

Amazon CLI

删除置备对象

以下delete-provisioning-artifact示例删除了指定的置备对象。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteProvisioningArtifact中的。

以下代码示例演示如何使用 delete-tag-option。

Amazon CLI

要删除 TagOption

以下delete-tag-option示例删除指定的 TagOption。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteTagOption中的。

以下代码示例演示如何使用 describe-copy-product-status。

Amazon CLI

描述复制产品操作的状态

以下describe-copy-product-status示例显示了指定异步复制产品操作的当前状态。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeCopyProductStatus中的。

以下代码示例演示如何使用 describe-portfolio。

Amazon CLI

描述投资组合

以下describe-portfolio示例显示了指定投资组合的详细信息。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribePortfolio中的。

以下代码示例演示如何使用 describe-product-as-admin。

Amazon CLI

以管理员身份描述产品

以下describe-product-as-admin示例使用管理员权限显示指定产品的详细信息。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeProductAsAdmin中的。

以下代码示例演示如何使用 describe-provisioned-product。

Amazon CLI

描述预配置的产品

以下describe-provisioned-product示例显示了指定预配置产品的详细信息。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeProvisionedProduct中的。

以下代码示例演示如何使用 describe-provisioning-artifact。

Amazon CLI

描述置备工件

以下describe-provisioning-artifact示例显示了指定置备对象的详细信息。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeProvisioningArtifact中的。

以下代码示例演示如何使用 describe-tag-option。

Amazon CLI

描述一个 TagOption

以下describe-tag-option示例显示了指定项的详细信息 TagOption。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeTagOption中的。

以下代码示例演示如何使用 disassociate-principal-from-portfolio。

Amazon CLI

解除本金与投资组合的关联

以下disassociate-principal-from-portfolio示例取消了指定本金与投资组合的关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DisassociatePrincipalFromPortfolio中的。

以下代码示例演示如何使用 disassociate-product-from-portfolio。

Amazon CLI

取消产品与产品组合的关联

以下disassociate-product-from-portfolio示例取消指定产品与产品组合的关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DisassociateProductFromPortfolio中的。

以下代码示例演示如何使用 disassociate-tag-option-from-resource。

Amazon CLI

取消与资源的 TagOption 关联

以下disassociate-tag-option-from-resource示例取消指定TagOption与资源的关联。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DisassociateTagOptionFromResource中的。

以下代码示例演示如何使用 list-accepted-portfolio-shares。

Amazon CLI

列出已接受的投资组合股份

以下list-accepted-portfolio-shares示例列出了该账户接受共享的所有产品组合，仅包括默认的 Service Catalog 产品组合。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListAcceptedPortfolioShares中的。

以下代码示例演示如何使用 list-portfolio-access。

Amazon CLI

列出有权访问投资组合的账户

以下list-portfolio-access示例列出了有权访问指定投资组合的 Amazon 账户。


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

输出：


{
    "AccountIds": [
        "123456789012"
    ]
}

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListPortfolioAccess中的。

以下代码示例演示如何使用 list-portfolios-for-product。

Amazon CLI

列出与产品关联的产品组合

以下list-portfolios-for-product示例列出了与指定产品关联的产品组合。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListPortfoliosForProduct中的。

以下代码示例演示如何使用 list-portfolios。

Amazon CLI

列出投资组合

以下list-portfolios示例列出了当前区域的 Service Catalog 产品组合。


aws servicecatalog list-portfolios

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListPortfolios中的。

以下代码示例演示如何使用 list-principals-for-portfolio。

Amazon CLI

列出投资组合的所有委托人

以下list-principals-for-portfolio示例列出了指定投资组合的所有委托人。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListPrincipalsForPortfolio中的。

以下代码示例演示如何使用 list-provisioning-artifacts。

Amazon CLI

列出产品的所有配置对象

以下list-provisioning-artifacts示例列出了指定产品的所有配置对象。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListProvisioningArtifacts中的。

以下代码示例演示如何使用 list-resources-for-tag-option。

Amazon CLI

列出与关联的资源 TagOption

以下list-resources-for-tag-option示例列出了与指定关联的资源TagOption。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListResourcesForTagOption中的。

以下代码示例演示如何使用 list-tag-options。

Amazon CLI

以下list-tag-options示例列出了的所有值TagOptions。


aws servicecatalog list-tag-options

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ListTagOptions中的。

以下代码示例演示如何使用 provision-product。

Amazon CLI

配置产品

以下provision-product示例使用指定的置备工件置备指定的产品。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ProvisionProduct中的。

以下代码示例演示如何使用 reject-portfolio-share。

Amazon CLI

拒绝投资组合份额

以下reject-portfolio-share示例拒绝给定投资组合的投资组合份额。


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

此命令不生成任何输出。

有关 API 的详细信息，请参阅Amazon CLI 命令参考RejectPortfolioShare中的。

以下代码示例演示如何使用 scan-provisioned-products。

Amazon CLI

列出所有可用的预配置产品

以下scan-provisioned-products示例列出了可用的预配置产品。


aws servicecatalog scan-provisioned-products

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考ScanProvisionedProducts中的。

以下代码示例演示如何使用 search-products-as-admin。

Amazon CLI

使用管理员权限搜索产品

以下search-products-as-admin示例使用产品组合 ID 作为筛选条件搜索具有管理员权限的产品。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考SearchProductsAsAdmin中的。

以下代码示例演示如何使用 search-provisioned-products。

Amazon CLI

搜索预配置的产品

以下search-provisioned-products示例使用 JSON 文件传递参数，搜索与指定产品 ID 匹配的预配置产品。


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

search-provisioned-products-input.json 的内容：


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考SearchProvisionedProducts中的。

以下代码示例演示如何使用 update-portfolio。

Amazon CLI

更新投资组合

以下update-portfolio示例更新了指定投资组合的名称。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdatePortfolio中的。

以下代码示例演示如何使用 update-product。

Amazon CLI

更新产品

以下update-product示例更新了指定产品的名称和所有者。


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateProduct中的。

以下代码示例演示如何使用 update-provisioning-artifact。

Amazon CLI

更新置备构件

以下update-provisioning-artifact示例使用 JSON 文件传递参数，更新了指定置备工件的名称和描述。


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

update-provisioning-artifact-input.json 的内容：


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateProvisioningArtifact中的。

以下代码示例演示如何使用 update-tag-option。

Amazon CLI

要更新 TagOption

以下update-tag-option示例使用指定的 JSON 文件更新 a TagOption 的值。


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

update-tag-option-input.json 的内容：


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

输出：


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

有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateTagOption中的。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

Amazon Serverless Application Repository

服务限额