を使用した Service Catalog の例 AWS CLI - AWS SDK コードの例
アクション

Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS

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

を使用した 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

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

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

次の例は、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 の例では、指定された JSON ファイルを使用して 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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateTagOption」を参照してください。