を使用した Service Catalog の例 AWS CLI - AWS Command Line Interface
アクション

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Service Catalog の例 AWS CLI

次のコード例は、Service Catalog AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

次の例は、accept-portfolio-share を使用する方法を説明しています。

AWS CLI

ポートフォリオ共有を受け入れるには

次のaccept-portfolio-share例では、指定されたポートフォリオを共有するために別のユーザーが行ったオファーを受け入れます。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスAcceptPortfolioShare」の「」を参照してください。

次の例は、associate-principal-with-portfolio を使用する方法を説明しています。

AWS 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

このコマンドでは何も出力されません。

次の例は、associate-product-with-portfolio を使用する方法を説明しています。

AWS CLI

製品をポートフォリオに関連付けるには

次のassociate-product-with-portfolio例では、指定された製品を指定されたポートフォリオに関連付けます。

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

このコマンドでは何も出力されません。

次のコード例は、associate-tag-option-with-resource を使用する方法を示しています。

AWS CLI

をリソース TagOption に関連付けるには

次のassociate-tag-option-with-resource例では、指定された を指定されたリソース TagOption に関連付けます。

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

このコマンドでは何も出力されません。

次のコード例は、copy-product を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスCopyProduct」の「」を参照してください。

次の例は、create-portfolio-share を使用する方法を説明しています。

AWS CLI

ポートフォリオをアカウントと共有するには

次のcreate-portfolio-share例では、指定されたポートフォリオを指定されたアカウントと共有します。

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

このコマンドは出力を生成しません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreatePortfolioShare」の「」を参照してください。

次のコード例は、create-portfolio を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスCreatePortfolio」の「」を参照してください。

次の例は、create-product を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスCreateProduct」の「」を参照してください。

次のコード例は、create-provisioning-artifact を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスCreateProvisioningArtifact」の「」を参照してください。

次の例は、create-tag-option を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスCreateTagOption」の「」を参照してください。

次の例は、delete-portfolio-share を使用する方法を説明しています。

AWS CLI

アカウントとポートフォリオの共有を停止するには

次のdelete-portfolio-share例では、指定されたアカウントとのポートフォリオの共有を停止します。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeletePortfolioShare」の「」を参照してください。

次の例は、delete-portfolio を使用する方法を説明しています。

AWS CLI

ポートフォリオを削除するには

次のdelete-portfolio例では、指定されたポートフォリオを削除します。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeletePortfolio」の「」を参照してください。

次の例は、delete-product を使用する方法を説明しています。

AWS CLI

製品を削除するには

次のdelete-product例では、指定された製品を削除します。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteProduct」の「」を参照してください。

次のコード例は、delete-provisioning-artifact を使用する方法を示しています。

AWS CLI

プロビジョニングアーティファクトを削除するには

次のdelete-provisioning-artifact例では、指定されたプロビジョニングアーティファクトを削除します。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteProvisioningArtifact」の「」を参照してください。

次の例は、delete-tag-option を使用する方法を説明しています。

AWS CLI

を削除するには TagOption

次のdelete-tag-option例では、指定された を削除します TagOption。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteTagOption」の「」を参照してください。

次の例は、describe-copy-product-status を使用する方法を説明しています。

AWS CLI

コピー製品オペレーションのステータスを記述するには

次のdescribe-copy-product-status例では、指定された非同期コピー製品オペレーションの現在のステータスを表示します。

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

出力:

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスDescribeCopyProductStatus」の「」を参照してください。

次のコード例は、describe-portfolio を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスDescribePortfolio」の「」を参照してください。

次の例は、describe-product-as-admin を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスDescribeProductAsAdmin」の「」を参照してください。

次のコード例は、describe-provisioned-product を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスDescribeProvisionedProduct」の「」を参照してください。

次の例は、describe-provisioning-artifact を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスDescribeProvisioningArtifact」の「」を参照してください。

次のコード例は、describe-tag-option を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスDescribeTagOption」の「」を参照してください。

次の例は、disassociate-principal-from-portfolio を使用する方法を説明しています。

AWS CLI

ポートフォリオからプリンシパルの関連付けを解除するには

次のdisassociate-principal-from-portfolio例では、指定されたプリンシパルとポートフォリオの関連付けを解除します。

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

このコマンドでは何も出力されません。

次のコード例は、disassociate-product-from-portfolio を使用する方法を示しています。

AWS CLI

ポートフォリオから製品の関連付けを解除するには

次のdisassociate-product-from-portfolio例では、指定された製品をポートフォリオから関連付け解除します。

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

このコマンドでは何も出力されません。

次の例は、disassociate-tag-option-from-resource を使用する方法を説明しています。

AWS CLI

リソース TagOption から の関連付けを解除するには

次のdisassociate-tag-option-from-resource例では、指定された をリソースTagOptionから関連付け解除します。

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

このコマンドでは何も出力されません。

次のコード例は、list-accepted-portfolio-shares を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListAcceptedPortfolioShares」の「」を参照してください。

次の例は、list-portfolio-access を使用する方法を説明しています。

AWS CLI

ポートフォリオにアクセスできるアカウントを一覧表示するには

次のlist-portfolio-access例では、指定されたポートフォリオにアクセスできる AWS アカウントを一覧表示します。

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

出力:

{
    "AccountIds": [
        "123456789012"
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスListPortfolioAccess」の「」を参照してください。

次のコード例は、list-portfolios-for-product を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListPortfoliosForProduct」の「」を参照してください。

次のコード例は、list-portfolios を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListPortfolios」の「」を参照してください。

次の例は、list-principals-for-portfolio を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListPrincipalsForPortfolio」の「」を参照してください。

次のコード例は、list-provisioning-artifacts を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListProvisioningArtifacts」の「」を参照してください。

次の例は、list-resources-for-tag-option を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListResourcesForTagOption」の「」を参照してください。

次の例は、list-tag-options を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスListTagOptions」の「」を参照してください。

次のコード例は、provision-product を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスProvisionProduct」の「」を参照してください。

次の例は、reject-portfolio-share を使用する方法を説明しています。

AWS CLI

ポートフォリオ共有を拒否するには

次のreject-portfolio-share例では、特定のポートフォリオのポートフォリオ共有を拒否します。

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

このコマンドでは何も出力されません。

  • API 詳細については、AWS CLI 「 コマンドリファレンスRejectPortfolioShare」の「」を参照してください。

次の例は、scan-provisioned-products を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスScanProvisionedProducts」の「」を参照してください。

次の例は、search-products-as-admin を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスSearchProductsAsAdmin」の「」を参照してください。

次の例は、search-provisioned-products を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスSearchProvisionedProducts」の「」を参照してください。

次の例は、update-portfolio を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスUpdatePortfolio」の「」を参照してください。

次の例は、update-product を使用する方法を説明しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスUpdateProduct」の「」を参照してください。

次のコード例は、update-provisioning-artifact を使用する方法を示しています。

AWS 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 詳細については、AWS CLI 「 コマンドリファレンスUpdateProvisioningArtifact」の「」を参照してください。

次のコード例は、update-tag-option を使用する方法を示しています。

AWS CLI

を更新するには TagOption

次のupdate-tag-option例ではTagOption、指定されたJSONファイルを使用して の値を更新します。

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 詳細については、AWS CLI 「 コマンドリファレンスUpdateTagOption」の「」を参照してください。