Beispiele für die Verwendung von Service Catalog mit AWS CLI - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung von Service Catalog mit AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie AWS Command Line Interface mit Service Catalog nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie accept-portfolio-share verwendet wird.

AWS CLI

So akzeptieren Sie eine Portfoliofreigabe

Im folgenden Beispiel für accept-portfolio-share wird ein Angebot eines anderen Benutzers zur gemeinsamen Nutzung des angegebenen Portfolios akzeptiert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie associate-principal-with-portfolio verwendet wird.

AWS CLI

So ordnen Sie einem Portfolio einen Prinzipal zu

Im folgenden Beispiel für associate-principal-with-portfolio wird ein Benutzer dem angegebene Portfolio zugeordnet.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie associate-product-with-portfolio verwendet wird.

AWS CLI

So ordnen Sie einem Portfolio ein Produkt zu

Im folgenden Beispiel für associate-product-with-portfolio wird dem angegebenen Portfolio das entsprechende Produkt zugeordnet.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie associate-tag-option-with-resource verwendet wird.

AWS CLI

So verknüpfen Sie eine TagOption mit einer Ressource

Im folgenden Beispiel für associate-tag-option-with-resource wird der angegebenen Ressource eine bestimmte TagOption zugeordnet.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie copy-product verwendet wird.

AWS CLI

So kopieren Sie ein Produkt

Im folgenden Beispiel für copy-product wird eine Kopie des angegebenen Produkts erstellt, wobei eine JSON-Datei verwendet wird, um Parameter zu übergeben.

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

Inhalt von copy-product-input.json:

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

Ausgabe:

{
    "CopyProductToken": "copyproduct-abc5defgjkdji"
}

  • API-Details finden Sie unter CopyProduct in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-portfolio-share verwendet wird.

AWS CLI

So geben Sie ein Portfolio für ein Konto frei

Im folgenden Beispiel für create-portfolio-share wird das angegebene Portfolio mit dem angegebenen Konto geteilt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie create-portfolio verwendet wird.

AWS CLI

So erstellen Sie ein Portfolio

Im folgenden Beispiel für create-portfolio wird ein Portfolio erstellt.

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

Ausgabe:

{
    "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-Details finden Sie unter CreatePortfolio in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-product verwendet wird.

AWS CLI

So erstellen Sie ein Produkt

Im folgenden Beispiel für create-product wird ein Produkt erstellt, wobei eine JSON-Datei verwendet wird, um Parameter zu übergeben.

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

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

Ausgabe:

{
    "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-Details finden Sie unter CreateProduct in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-provisioning-artifact verwendet wird.

AWS CLI

So erstellen Sie ein Bereitstellungsartefakt

Im folgenden Beispiel für create-provisioning-artifact wird ein Bereitstellungsartefakt erstellt, wobei eine JSON-Datei verwendet wird, um Parameter zu übergeben.

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

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie create-tag-option verwendet wird.

AWS CLI

So erstellen Sie eine TagOption

Im folgenden Beispiel für create-tag-option wird eine TagOption erstellt.

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

Ausgabe:

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

  • API-Details finden Sie unter CreateTagOption in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-portfolio-share verwendet wird.

AWS CLI

So beenden Sie die Freigabe eines Portfolios für ein Konto

Im folgenden Beispiel für delete-portfolio-share wird die Freigabe des Portfolios mit dem angegebenen Konto beendet.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie delete-portfolio verwendet wird.

AWS CLI

So löschen Sie ein Portfolio

Im folgenden Beispiel für delete-portfolio wird das angegebene Portfolio gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

  • API-Details finden Sie unter DeletePortfolio in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-product verwendet wird.

AWS CLI

So löschen Sie ein Produkt

Im folgenden Beispiel für delete-product wird das angegebene Produkt gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

  • API-Details finden Sie unter DeleteProduct in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-provisioning-artifact verwendet wird.

AWS CLI

So löschen Sie ein Bereitstellungsartefakt

Im folgenden Beispiel für delete-provisioning-artifact wird das angegebene Bereitstellungsartefakt gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie delete-tag-option verwendet wird.

AWS CLI

So löschen Sie eine TagOption

Im folgenden Beispiel für delete-tag-option wird die angegebene TagOption gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

  • API-Details finden Sie unter DeleteTagOption in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-copy-product-status verwendet wird.

AWS CLI

So beschreiben Sie den Status der Produktkopierungsoption

Im folgenden Beispiel für describe-copy-product-status wird der aktuelle Status der angegebenen asynchronen Produktkopierungsoption angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie describe-portfolio verwendet wird.

AWS CLI

So beschreiben Sie ein Portfolio

Im folgenden Beispiel für describe-portfolio werden Details für das angegebene Portfolio angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie describe-product-as-admin verwendet wird.

AWS CLI

So beschreiben Sie ein Produkt als Administrator

Im folgenden Beispiel für describe-product-as-admin werden die Details für das angegebene Produkt mit Administratorrechten angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie describe-provisioned-product verwendet wird.

AWS CLI

So beschreiben Sie ein bereitgestelltes Produkt

Im folgenden Beispiel für describe-provisioned-product werden Details für die angegebene bereitgestellte Produkt angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie describe-provisioning-artifact verwendet wird.

AWS CLI

So beschreiben Sie ein Bereitstellungsartefakt

Im folgenden Beispiel für describe-provisioning-artifact werden Details zu dem angegebenen Bereitstellungsartefakt angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie describe-tag-option verwendet wird.

AWS CLI

So beschreiben Sie eine TagOption

Im folgenden Beispiel für describe-tag-option werden Details zur angegebenen TagOption angezeigt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie disassociate-principal-from-portfolio verwendet wird.

AWS CLI

So heben Sie die Zuordnung eines Prinzipals zu einem Portfolio auf

Im folgenden Beispiel für disassociate-principal-from-portfolio wird die Zuordnung des angegebenen Prinzipal zum Portfolio aufgehoben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie disassociate-product-from-portfolio verwendet wird.

AWS CLI

So heben Sie die Zuordnung eines Produkts zu einem Portfolio auf

Im folgenden Beispiel für disassociate-product-from-portfolio wird die Zuordnung des angegebenen Produkts zu dem Portfolio aufgehoben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie disassociate-tag-option-from-resource verwendet wird.

AWS CLI

So heben Sie die Zuordnung einer TagOption zu einer Ressource auf

Im folgenden Beispiel für disassociate-tag-option-from-resource wird die Zuordnung der angegebenen TagOption und der Ressource aufgehoben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie list-accepted-portfolio-shares verwendet wird.

AWS CLI

So listen Sie akzeptierte Portfoliofreigaben auf

Im folgenden Beispiel für list-accepted-portfolio-shares werden alle Portfolios aufgelistet, für die Freigaben von diesem Konto akzeptiert wurden, einschließlich des standardmäßigen Service Catalog-Portfolios.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie list-portfolio-access verwendet wird.

AWS CLI

So listen Sie Konten mit Zugriff auf ein Portfolio auf

Im folgenden Beispiel für list-portfolio-access werden die AWS-Konten aufgelistet, die Zugriff auf das angegebene Portfolio haben.

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

Ausgabe:

{
    "AccountIds": [
        "123456789012"
    ]
}

Das folgende Codebeispiel zeigt, wie list-portfolios-for-product verwendet wird.

AWS CLI

So listen Sie Portfolios auf, denen ein Produkt zugeordnet ist

Im folgenden Beispiel für list-portfolios-for-product werden die Portfolios aufgelistet, denen das entsprechende Produkt zugeordnet ist.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie list-portfolios verwendet wird.

AWS CLI

So listen Sie Portfolios auf

Im folgenden Beispiel für list-portfolios werden alle Service Catalog-Portfolios in der aktuellen Region aufgelistet.

aws servicecatalog list-portfolios

Ausgabe:

{
    "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-Details finden Sie unter ListPortfolios in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-principals-for-portfolio verwendet wird.

AWS CLI

So listen Sie alle Prinzipale für ein Portfolio auf

Im folgenden Beispiel für list-principals-for-portfolio werden alle Prinzipale für das angegebene Portfolio aufgelistet.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie list-provisioning-artifacts verwendet wird.

AWS CLI

So listen Sie alle Bereitstellungsartefakte für ein Produkt auf

Im folgenden Beispiel für list-provisioning-artifacts werden alle Bereitstellungsartefakte für das angegebene Produkt aufgelistet.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie list-resources-for-tag-option verwendet wird.

AWS CLI

So listen Sie Ressourcen auf, die einer TagOption zugeordnet sind

Im folgenden Beispiel für list-resources-for-tag-option werden die Ressourcen aufgelistet, die der angegebenen TagOption zugeordnet sind.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie list-tag-options verwendet wird.

AWS CLI

Im folgenden Beispiel für list-tag-options werden alle Werte für TagOptions aufgelistet.

aws servicecatalog list-tag-options

Ausgabe:

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

  • API-Details finden Sie unter ListTagOptions in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie provision-product verwendet wird.

AWS CLI

So stellen Sie ein Produkt bereit

Im folgenden Beispiel für provision-product wird das angegebene Produkt mithilfe des angegebenen Bereitstellungsartefakts bereitgestellt.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie reject-portfolio-share verwendet wird.

AWS CLI

So lehnen Sie ein Portfoliofreigabe ab

Im folgenden Beispiel für reject-portfolio-share wird die Portfoliofreigabe für das angegebene Portfolio abgelehnt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Das folgende Codebeispiel zeigt, wie scan-provisioned-products verwendet wird.

AWS CLI

So listen Sie alle verfügbaren bereitgestellten Produkte auf

Im folgenden Beispiel für scan-provisioned-products listet die verfügbaren bereitgestellten Produkte auf.

aws servicecatalog scan-provisioned-products

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie search-products-as-admin verwendet wird.

AWS CLI

So suchen Sie nach Produkten mit Administratorrechten

Im folgenden Beispiel für search-products-as-admin wird nach Produkten mit Administratorrechten gesucht, wobei eine Portfolio-ID als Filter verwendet wird.

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie search-provisioned-products verwendet wird.

AWS CLI

So suchen Sie nach bereitgestellten Produkten

Im folgenden Beispiel für search-provisioned-products wird nach bereitgestellten Produkten gesucht, die der angegebenen Produkt-ID entsprechen, wobei eine JSON-Datei zur Übergabe von Parametern verwendet wird.

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

Inhalt von search-provisioned-products-input.json:

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie update-portfolio verwendet wird.

AWS CLI

So aktualisieren Sie ein Portfolio

Im folgenden Beispiel für update-portfolio wird der Name des angegebenen Portfolios aktualisiert.

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

Ausgabe:

{
    "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-Details finden Sie unter UpdatePortfolio in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-product verwendet wird.

AWS CLI

So aktualisieren Sie ein Produkt

Im folgenden Beispiel für update-product wird der Name und Besitzer des angegebenen Products aktualisiert.

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

Ausgabe:

{
    "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-Details finden Sie unter UpdateProduct in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-provisioning-artifact verwendet wird.

AWS CLI

So aktualisieren Sie ein Bereitstellungsartefakt

Im folgenden Beispiel für update-provisioning-artifact werden der Name und die Beschreibung des angegebenen Bereitstellungsartefakts aktualisiert, wobei eine JSON-Datei zur Übergabe von Parametern verwendet wird.

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

Inhalt von update-provisioning-artifact-input.json:

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

Ausgabe:

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

Das folgende Codebeispiel zeigt, wie update-tag-option verwendet wird.

AWS CLI

So aktualisieren Sie eine TagOption

Im folgenden Beispiel für update-tag-option wird der Wert von TagOption mithilfe der angegebenen JSON-Datei aktualisiert.

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

Inhalt von update-tag-option-input.json:

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

Ausgabe:

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

  • API-Details finden Sie unter UpdateTagOption in der AWS CLI-Befehlsreferenz.