ServiceCatalog ************** Client ====== class ServiceCatalog.Client A low-level client representing AWS Service Catalog Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts. import boto3 client = boto3.client('servicecatalog') These are the available methods: * accept_portfolio_share * associate_budget_with_resource * associate_principal_with_portfolio * associate_product_with_portfolio * associate_service_action_with_provisioning_artifact * associate_tag_option_with_resource * batch_associate_service_action_with_provisioning_artifact * batch_disassociate_service_action_from_provisioning_artifact * can_paginate * close * copy_product * create_constraint * create_portfolio * create_portfolio_share * create_product * create_provisioned_product_plan * create_provisioning_artifact * create_service_action * create_tag_option * delete_constraint * delete_portfolio * delete_portfolio_share * delete_product * delete_provisioned_product_plan * delete_provisioning_artifact * delete_service_action * delete_tag_option * describe_constraint * describe_copy_product_status * describe_portfolio * describe_portfolio_share_status * describe_portfolio_shares * describe_product * describe_product_as_admin * describe_product_view * describe_provisioned_product * describe_provisioned_product_plan * describe_provisioning_artifact * describe_provisioning_parameters * describe_record * describe_service_action * describe_service_action_execution_parameters * describe_tag_option * disable_aws_organizations_access * disassociate_budget_from_resource * disassociate_principal_from_portfolio * disassociate_product_from_portfolio * disassociate_service_action_from_provisioning_artifact * disassociate_tag_option_from_resource * enable_aws_organizations_access * execute_provisioned_product_plan * execute_provisioned_product_service_action * get_aws_organizations_access_status * get_paginator * get_provisioned_product_outputs * get_waiter * import_as_provisioned_product * list_accepted_portfolio_shares * list_budgets_for_resource * list_constraints_for_portfolio * list_launch_paths * list_organization_portfolio_access * list_portfolio_access * list_portfolios * list_portfolios_for_product * list_principals_for_portfolio * list_provisioned_product_plans * list_provisioning_artifacts * list_provisioning_artifacts_for_service_action * list_record_history * list_resources_for_tag_option * list_service_actions * list_service_actions_for_provisioning_artifact * list_stack_instances_for_provisioned_product * list_tag_options * notify_provision_product_engine_workflow_result * notify_terminate_provisioned_product_engine_workflow_result * notify_update_provisioned_product_engine_workflow_result * provision_product * reject_portfolio_share * scan_provisioned_products * search_products * search_products_as_admin * search_provisioned_products * terminate_provisioned_product * update_constraint * update_portfolio * update_portfolio_share * update_product * update_provisioned_product * update_provisioned_product_properties * update_provisioning_artifact * update_service_action * update_tag_option Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAcceptedPortfolioShares * ListConstraintsForPortfolio * ListLaunchPaths * ListOrganizationPortfolioAccess * ListPortfolios * ListPortfoliosForProduct * ListPrincipalsForPortfolio * ListProvisionedProductPlans * ListProvisioningArtifactsForServiceAction * ListRecordHistory * ListResourcesForTagOption * ListServiceActions * ListServiceActionsForProvisioningArtifact * ListTagOptions * ScanProvisionedProducts * SearchProductsAsAdmin ServiceCatalog / Paginator / SearchProductsAsAdmin SearchProductsAsAdmin ********************* class ServiceCatalog.Paginator.SearchProductsAsAdmin paginator = client.get_paginator('search_products_as_admin') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.search_products_as_admin()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PortfolioId='string', Filters={ 'string': [ 'string', ] }, SortBy='Title'|'VersionCount'|'CreationDate', SortOrder='ASCENDING'|'DESCENDING', ProductSource='ACCOUNT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PortfolioId** (*string*) -- The portfolio identifier. * **Filters** (*dict*) -- The search filters. If no search filters are specified, the output includes all products to which the administrator has access. * *(string) --* * *(list) --* * *(string) --* * **SortBy** (*string*) -- The sort field. If no value is specified, the results are not sorted. * **SortOrder** (*string*) -- The sort order. If no value is specified, the results are not sorted. * **ProductSource** (*string*) -- Access level of the source of the product. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProductViewDetails': [ { 'ProductViewSummary': { 'Id': 'string', 'ProductId': 'string', 'Name': 'string', 'Owner': 'string', 'ShortDescription': 'string', 'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL', 'Distributor': 'string', 'HasDefaultPath': True|False, 'SupportEmail': 'string', 'SupportDescription': 'string', 'SupportUrl': 'string' }, 'Status': 'AVAILABLE'|'CREATING'|'FAILED', 'ProductARN': 'string', 'CreatedTime': datetime(2015, 1, 1), 'SourceConnection': { 'Type': 'CODESTAR', 'ConnectionParameters': { 'CodeStar': { 'ConnectionArn': 'string', 'Repository': 'string', 'Branch': 'string', 'ArtifactPath': 'string' } }, 'LastSync': { 'LastSyncTime': datetime(2015, 1, 1), 'LastSyncStatus': 'SUCCEEDED'|'FAILED', 'LastSyncStatusMessage': 'string', 'LastSuccessfulSyncTime': datetime(2015, 1, 1), 'LastSuccessfulSyncProvisioningArtifactId': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProductViewDetails** *(list) --* Information about the product views. * *(dict) --* Information about a product view. * **ProductViewSummary** *(dict) --* Summary information about the product view. * **Id** *(string) --* The product view identifier. * **ProductId** *(string) --* The product identifier. * **Name** *(string) --* The name of the product. * **Owner** *(string) --* The owner of the product. Contact the product administrator for the significance of this value. * **ShortDescription** *(string) --* Short description of the product. * **Type** *(string) --* The product type. Contact the product administrator for the significance of this value. If this value is "MARKETPLACE", the product was created by Amazon Web Services Marketplace. * **Distributor** *(string) --* The distributor of the product. Contact the product administrator for the significance of this value. * **HasDefaultPath** *(boolean) --* Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters. * **SupportEmail** *(string) --* The email contact information to obtain support for this Product. * **SupportDescription** *(string) --* The description of the support for this Product. * **SupportUrl** *(string) --* The URL information to obtain support for this Product. * **Status** *(string) --* The status of the product. * "AVAILABLE" - The product is ready for use. * "CREATING" - Product creation has started; the product is not ready for use. * "FAILED" - An action failed. * **ProductARN** *(string) --* The ARN of the product. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **SourceConnection** *(dict) --* A top level "ProductViewDetail" response containing details about the product’s connection. Service Catalog returns this field for the "CreateProduct", "UpdateProduct", "DescribeProductAsAdmin", and "SearchProductAsAdmin" APIs. This response contains the same fields as the "ConnectionParameters" request, with the addition of the "LastSync" response. * **Type** *(string) --* The only supported "SourceConnection" type is Codestar. * **ConnectionParameters** *(dict) --* The connection details based on the connection "Type". * **CodeStar** *(dict) --* Provides "ConnectionType" details. * **ConnectionArn** *(string) --* The CodeStar ARN, which is the connection between Service Catalog and the external repository. * **Repository** *(string) --* The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo." * **Branch** *(string) --* The specific branch where the artifact resides. * **ArtifactPath** *(string) --* The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json." * **LastSync** *(dict) --* Provides details about the product's connection sync and contains the following sub-fields. * "LastSyncTime" * "LastSyncStatus" * "LastSyncStatusMessage" * "LastSuccessfulSyncTime" * "LastSuccessfulSyncProvisioningArtifactID" * **LastSyncTime** *(datetime) --* The time of the last attempted sync from the repository to the Service Catalog product. * **LastSyncStatus** *(string) --* The current status of the sync. Responses include "SUCCEEDED" or "FAILED". * **LastSyncStatusMessage** *(string) --* The sync's status message. * **LastSuccessfulSyncTime** *(datetime) --* The time of the latest successful sync from the source repo artifact to the Service Catalog product. * **LastSuccessfulSyncProvisioningArtifactId** *(string) --* The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListRecordHistory ListRecordHistory ***************** class ServiceCatalog.Paginator.ListRecordHistory paginator = client.get_paginator('list_record_history') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_record_history()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', AccessLevelFilter={ 'Key': 'Account'|'Role'|'User', 'Value': 'string' }, SearchFilter={ 'Key': 'string', 'Value': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **AccessLevelFilter** (*dict*) -- The access level to use to obtain results. The default is "User". * **Key** *(string) --* The access level. * "Account" - Filter results based on the account. * "Role" - Filter results based on the federated role of the specified user. * "User" - Filter results based on the specified user. * **Value** *(string) --* The user to which the access level applies. The only supported value is "self". * **SearchFilter** (*dict*) -- The search filter to scope the results. * **Key** *(string) --* The filter key. * "product" - Filter results based on the specified product identifier. * "provisionedproduct" - Filter results based on the provisioned product identifier. * **Value** *(string) --* The filter value. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RecordDetails': [ { 'RecordId': 'string', 'ProvisionedProductName': 'string', 'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED', 'CreatedTime': datetime(2015, 1, 1), 'UpdatedTime': datetime(2015, 1, 1), 'ProvisionedProductType': 'string', 'RecordType': 'string', 'ProvisionedProductId': 'string', 'ProductId': 'string', 'ProvisioningArtifactId': 'string', 'PathId': 'string', 'RecordErrors': [ { 'Code': 'string', 'Description': 'string' }, ], 'RecordTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LaunchRoleArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RecordDetails** *(list) --* The records, in reverse chronological order. * *(dict) --* Information about a request operation. * **RecordId** *(string) --* The identifier of the record. * **ProvisionedProductName** *(string) --* The user-friendly name of the provisioned product. * **Status** *(string) --* The status of the provisioned product. * "CREATED" - The request was created but the operation has not started. * "IN_PROGRESS" - The requested operation is in progress. * "IN_PROGRESS_IN_ERROR" - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback. * "SUCCEEDED" - The requested operation has successfully completed. * "FAILED" - The requested operation has unsuccessfully completed. Investigate using the error messages returned. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **UpdatedTime** *(datetime) --* The time when the record was last updated. * **ProvisionedProductType** *(string) --* The type of provisioned product. The supported values are "CFN_STACK", "CFN_STACKSET", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", and "EXTERNAL". * **RecordType** *(string) --* The record type. * "PROVISION_PRODUCT" * "UPDATE_PROVISIONED_PRODUCT" * "TERMINATE_PROVISIONED_PRODUCT" * **ProvisionedProductId** *(string) --* The identifier of the provisioned product. * **ProductId** *(string) --* The product identifier. * **ProvisioningArtifactId** *(string) --* The identifier of the provisioning artifact. * **PathId** *(string) --* The path identifier. * **RecordErrors** *(list) --* The errors that occurred. * *(dict) --* The error code and description resulting from an operation. * **Code** *(string) --* The numeric value of the error. * **Description** *(string) --* The description of the error. * **RecordTags** *(list) --* One or more tags. * *(dict) --* Information about a tag, which is a key-value pair. * **Key** *(string) --* The key for this tag. * **Value** *(string) --* The value for this tag. * **LaunchRoleArn** *(string) --* The ARN of the launch role associated with the provisioned product. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListResourcesForTagOption ListResourcesForTagOption ************************* class ServiceCatalog.Paginator.ListResourcesForTagOption paginator = client.get_paginator('list_resources_for_tag_option') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_resources_for_tag_option()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TagOptionId='string', ResourceType='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TagOptionId** (*string*) -- **[REQUIRED]** The TagOption identifier. * **ResourceType** (*string*) -- The resource type. * "Portfolio" * "Product" * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ResourceDetails': [ { 'Id': 'string', 'ARN': 'string', 'Name': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ResourceDetails** *(list) --* Information about the resources. * *(dict) --* Information about a resource. * **Id** *(string) --* The identifier of the resource. * **ARN** *(string) --* The ARN of the resource. * **Name** *(string) --* The name of the resource. * **Description** *(string) --* The description of the resource. * **CreatedTime** *(datetime) --* The creation time of the resource. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListConstraintsForPortfolio ListConstraintsForPortfolio *************************** class ServiceCatalog.Paginator.ListConstraintsForPortfolio paginator = client.get_paginator('list_constraints_for_portfolio') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_constraints_for_portfolio()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PortfolioId='string', ProductId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PortfolioId** (*string*) -- **[REQUIRED]** The portfolio identifier. * **ProductId** (*string*) -- The product identifier. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConstraintDetails': [ { 'ConstraintId': 'string', 'Type': 'string', 'Description': 'string', 'Owner': 'string', 'ProductId': 'string', 'PortfolioId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConstraintDetails** *(list) --* Information about the constraints. * *(dict) --* Information about a constraint. * **ConstraintId** *(string) --* The identifier of the constraint. * **Type** *(string) --* The type of constraint. * "LAUNCH" * "NOTIFICATION" * STACKSET * "TEMPLATE" * **Description** *(string) --* The description of the constraint. * **Owner** *(string) --* The owner of the constraint. * **ProductId** *(string) --* The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio. * **PortfolioId** *(string) --* The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListTagOptions ListTagOptions ************** class ServiceCatalog.Paginator.ListTagOptions paginator = client.get_paginator('list_tag_options') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_tag_options()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters={ 'Key': 'string', 'Value': 'string', 'Active': True|False }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*dict*) -- The search filters. If no search filters are specified, the output includes all TagOptions. * **Key** *(string) --* The TagOption key. * **Value** *(string) --* The TagOption value. * **Active** *(boolean) --* The active state. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TagOptionDetails': [ { 'Key': 'string', 'Value': 'string', 'Active': True|False, 'Id': 'string', 'Owner': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TagOptionDetails** *(list) --* Information about the TagOptions. * *(dict) --* Information about a TagOption. * **Key** *(string) --* The TagOption key. * **Value** *(string) --* The TagOption value. * **Active** *(boolean) --* The TagOption active state. * **Id** *(string) --* The TagOption identifier. * **Owner** *(string) --* The Amazon Web Services account Id of the owner account that created the TagOption. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListProvisionedProductPlans ListProvisionedProductPlans *************************** class ServiceCatalog.Paginator.ListProvisionedProductPlans paginator = client.get_paginator('list_provisioned_product_plans') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_provisioned_product_plans()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', ProvisionProductId='string', AccessLevelFilter={ 'Key': 'Account'|'Role'|'User', 'Value': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **ProvisionProductId** (*string*) -- The product identifier. * **AccessLevelFilter** (*dict*) -- The access level to use to obtain results. The default is "User". * **Key** *(string) --* The access level. * "Account" - Filter results based on the account. * "Role" - Filter results based on the federated role of the specified user. * "User" - Filter results based on the specified user. * **Value** *(string) --* The user to which the access level applies. The only supported value is "self". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProvisionedProductPlans': [ { 'PlanName': 'string', 'PlanId': 'string', 'ProvisionProductId': 'string', 'ProvisionProductName': 'string', 'PlanType': 'CLOUDFORMATION', 'ProvisioningArtifactId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProvisionedProductPlans** *(list) --* Information about the plans. * *(dict) --* Summary information about a plan. * **PlanName** *(string) --* The name of the plan. * **PlanId** *(string) --* The plan identifier. * **ProvisionProductId** *(string) --* The product identifier. * **ProvisionProductName** *(string) --* The user-friendly name of the provisioned product. * **PlanType** *(string) --* The plan type. * **ProvisioningArtifactId** *(string) --* The identifier of the provisioning artifact. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListAcceptedPortfolioShares ListAcceptedPortfolioShares *************************** class ServiceCatalog.Paginator.ListAcceptedPortfolioShares paginator = client.get_paginator('list_accepted_portfolio_shares') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_accepted_portfolio_shares()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PortfolioShareType='IMPORTED'|'AWS_SERVICECATALOG'|'AWS_ORGANIZATIONS', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PortfolioShareType** (*string*) -- The type of shared portfolios to list. The default is to list imported portfolios. * "AWS_ORGANIZATIONS" - List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization. * "AWS_SERVICECATALOG" - Deprecated type. * "IMPORTED" - List imported portfolios that have been accepted and shared through account-to-account sharing. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PortfolioDetails': [ { 'Id': 'string', 'ARN': 'string', 'DisplayName': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'ProviderName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PortfolioDetails** *(list) --* Information about the portfolios. * *(dict) --* Information about a portfolio. * **Id** *(string) --* The portfolio identifier. * **ARN** *(string) --* The ARN assigned to the portfolio. * **DisplayName** *(string) --* The name to use for display purposes. * **Description** *(string) --* The description of the portfolio. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **ProviderName** *(string) --* The name of the portfolio provider. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListServiceActions ListServiceActions ****************** class ServiceCatalog.Paginator.ListServiceActions paginator = client.get_paginator('list_service_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_service_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServiceActionSummaries': [ { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'DefinitionType': 'SSM_AUTOMATION' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ServiceActionSummaries** *(list) --* An object containing information about the service actions associated with the provisioning artifact. * *(dict) --* Detailed information about the self-service action. * **Id** *(string) --* The self-service action identifier. * **Name** *(string) --* The self-service action name. * **Description** *(string) --* The self-service action description. * **DefinitionType** *(string) --* The self-service action definition type. For example, "SSM_AUTOMATION". * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListProvisioningArtifactsForServiceAction ListProvisioningArtifactsForServiceAction ***************************************** class ServiceCatalog.Paginator.ListProvisioningArtifactsForServiceAction paginator = client.get_paginator('list_provisioning_artifacts_for_service_action') paginate(**kwargs) Creates an iterator that will paginate through responses from " ServiceCatalog.Client.list_provisioning_artifacts_for_service_a ction()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ServiceActionId='string', AcceptLanguage='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ServiceActionId** (*string*) -- **[REQUIRED]** The self-service action identifier. For example, "act- fs7abcd89wxyz". * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProvisioningArtifactViews': [ { 'ProductViewSummary': { 'Id': 'string', 'ProductId': 'string', 'Name': 'string', 'Owner': 'string', 'ShortDescription': 'string', 'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL', 'Distributor': 'string', 'HasDefaultPath': True|False, 'SupportEmail': 'string', 'SupportDescription': 'string', 'SupportUrl': 'string' }, 'ProvisioningArtifact': { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'Guidance': 'DEFAULT'|'DEPRECATED' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProvisioningArtifactViews** *(list) --* An array of objects with information about product views and provisioning artifacts. * *(dict) --* An object that contains summary information about a product view and a provisioning artifact. * **ProductViewSummary** *(dict) --* Summary information about a product view. * **Id** *(string) --* The product view identifier. * **ProductId** *(string) --* The product identifier. * **Name** *(string) --* The name of the product. * **Owner** *(string) --* The owner of the product. Contact the product administrator for the significance of this value. * **ShortDescription** *(string) --* Short description of the product. * **Type** *(string) --* The product type. Contact the product administrator for the significance of this value. If this value is "MARKETPLACE", the product was created by Amazon Web Services Marketplace. * **Distributor** *(string) --* The distributor of the product. Contact the product administrator for the significance of this value. * **HasDefaultPath** *(boolean) --* Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters. * **SupportEmail** *(string) --* The email contact information to obtain support for this Product. * **SupportDescription** *(string) --* The description of the support for this Product. * **SupportUrl** *(string) --* The URL information to obtain support for this Product. * **ProvisioningArtifact** *(dict) --* Information about a provisioning artifact. A provisioning artifact is also known as a product version. * **Id** *(string) --* The identifier of the provisioning artifact. * **Name** *(string) --* The name of the provisioning artifact. * **Description** *(string) --* The description of the provisioning artifact. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **Guidance** *(string) --* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListLaunchPaths ListLaunchPaths *************** class ServiceCatalog.Paginator.ListLaunchPaths paginator = client.get_paginator('list_launch_paths') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_launch_paths()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', ProductId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **ProductId** (*string*) -- **[REQUIRED]** The product identifier. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LaunchPathSummaries': [ { 'Id': 'string', 'ConstraintSummaries': [ { 'Type': 'string', 'Description': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LaunchPathSummaries** *(list) --* Information about the launch path. * *(dict) --* Summary information about a product path for a user. * **Id** *(string) --* The identifier of the product path. * **ConstraintSummaries** *(list) --* The constraints on the portfolio-product relationship. * *(dict) --* Summary information about a constraint. * **Type** *(string) --* The type of constraint. * "LAUNCH" * "NOTIFICATION" * STACKSET * "TEMPLATE" * **Description** *(string) --* The description of the constraint. * **Tags** *(list) --* The tags associated with this product path. * *(dict) --* Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product. * **Key** *(string) --* The tag key. * **Value** *(string) --* The value for this key. * **Name** *(string) --* The name of the portfolio that contains the product. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ScanProvisionedProducts ScanProvisionedProducts *********************** class ServiceCatalog.Paginator.ScanProvisionedProducts paginator = client.get_paginator('scan_provisioned_products') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.scan_provisioned_products()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', AccessLevelFilter={ 'Key': 'Account'|'Role'|'User', 'Value': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **AccessLevelFilter** (*dict*) -- The access level to use to obtain results. The default is "User". * **Key** *(string) --* The access level. * "Account" - Filter results based on the account. * "Role" - Filter results based on the federated role of the specified user. * "User" - Filter results based on the specified user. * **Value** *(string) --* The user to which the access level applies. The only supported value is "self". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProvisionedProducts': [ { 'Name': 'string', 'Arn': 'string', 'Type': 'string', 'Id': 'string', 'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS', 'StatusMessage': 'string', 'CreatedTime': datetime(2015, 1, 1), 'IdempotencyToken': 'string', 'LastRecordId': 'string', 'LastProvisioningRecordId': 'string', 'LastSuccessfulProvisioningRecordId': 'string', 'ProductId': 'string', 'ProvisioningArtifactId': 'string', 'LaunchRoleArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProvisionedProducts** *(list) --* Information about the provisioned products. * *(dict) --* Information about a provisioned product. * **Name** *(string) --* The user-friendly name of the provisioned product. * **Arn** *(string) --* The ARN of the provisioned product. * **Type** *(string) --* The type of provisioned product. The supported values are "CFN_STACK", "CFN_STACKSET", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", and "EXTERNAL". * **Id** *(string) --* The identifier of the provisioned product. * **Status** *(string) --* The current status of the provisioned product. * "AVAILABLE" - Stable state, ready to perform any operation. The most recent operation succeeded and completed. * "UNDER_CHANGE" - Transitive state. Operations performed might not have valid results. Wait for an "AVAILABLE" status before performing operations. * "TAINTED" - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. * "ERROR" - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack. * "PLAN_IN_PROGRESS" - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an "AVAILABLE" status before performing operations. * **StatusMessage** *(string) --* The current status message of the provisioned product. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **IdempotencyToken** *(string) --* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. * **LastRecordId** *(string) --* The record identifier of the last request performed on this provisioned product. * **LastProvisioningRecordId** *(string) --* The record identifier of the last request performed on this provisioned product of the following types: * ProvisionProduct * UpdateProvisionedProduct * ExecuteProvisionedProductPlan * TerminateProvisionedProduct * **LastSuccessfulProvisioningRecordId** *(string) --* The record identifier of the last successful request performed on this provisioned product of the following types: * ProvisionProduct * UpdateProvisionedProduct * ExecuteProvisionedProductPlan * TerminateProvisionedProduct * **ProductId** *(string) --* The product identifier. For example, "prod- abcdzk7xy33qa". * **ProvisioningArtifactId** *(string) --* The identifier of the provisioning artifact. For example, "pa-4abcdjnxjj6ne". * **LaunchRoleArn** *(string) --* The ARN of the launch role associated with the provisioned product. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListPortfolios ListPortfolios ************** class ServiceCatalog.Paginator.ListPortfolios paginator = client.get_paginator('list_portfolios') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_portfolios()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PortfolioDetails': [ { 'Id': 'string', 'ARN': 'string', 'DisplayName': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'ProviderName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PortfolioDetails** *(list) --* Information about the portfolios. * *(dict) --* Information about a portfolio. * **Id** *(string) --* The portfolio identifier. * **ARN** *(string) --* The ARN assigned to the portfolio. * **DisplayName** *(string) --* The name to use for display purposes. * **Description** *(string) --* The description of the portfolio. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **ProviderName** *(string) --* The name of the portfolio provider. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListPortfoliosForProduct ListPortfoliosForProduct ************************ class ServiceCatalog.Paginator.ListPortfoliosForProduct paginator = client.get_paginator('list_portfolios_for_product') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_portfolios_for_product()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', ProductId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **ProductId** (*string*) -- **[REQUIRED]** The product identifier. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PortfolioDetails': [ { 'Id': 'string', 'ARN': 'string', 'DisplayName': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'ProviderName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PortfolioDetails** *(list) --* Information about the portfolios. * *(dict) --* Information about a portfolio. * **Id** *(string) --* The portfolio identifier. * **ARN** *(string) --* The ARN assigned to the portfolio. * **DisplayName** *(string) --* The name to use for display purposes. * **Description** *(string) --* The description of the portfolio. * **CreatedTime** *(datetime) --* The UTC time stamp of the creation time. * **ProviderName** *(string) --* The name of the portfolio provider. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListOrganizationPortfolioAccess ListOrganizationPortfolioAccess ******************************* class ServiceCatalog.Paginator.ListOrganizationPortfolioAccess paginator = client.get_paginator('list_organization_portfolio_access') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_organization_portfolio_access()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PortfolioId='string', OrganizationNodeType='ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PortfolioId** (*string*) -- **[REQUIRED]** The portfolio identifier. For example, "port- 2abcdext3y5fk". * **OrganizationNodeType** (*string*) -- **[REQUIRED]** The organization node type that will be returned in the output. * "ORGANIZATION" - Organization that has access to the portfolio. * "ORGANIZATIONAL_UNIT" - Organizational unit that has access to the portfolio within your organization. * "ACCOUNT" - Account that has access to the portfolio within your organization. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'OrganizationNodes': [ { 'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT', 'Value': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **OrganizationNodes** *(list) --* Displays information about the organization nodes. * *(dict) --* Information about the organization node. * **Type** *(string) --* The organization node type. * **Value** *(string) --* The identifier of the organization node. * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListServiceActionsForProvisioningArtifact ListServiceActionsForProvisioningArtifact ***************************************** class ServiceCatalog.Paginator.ListServiceActionsForProvisioningArtifact paginator = client.get_paginator('list_service_actions_for_provisioning_artifact') paginate(**kwargs) Creates an iterator that will paginate through responses from " ServiceCatalog.Client.list_service_actions_for_provisioning_art ifact()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProductId='string', ProvisioningArtifactId='string', AcceptLanguage='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProductId** (*string*) -- **[REQUIRED]** The product identifier. For example, "prod-abcdzk7xy33qa". * **ProvisioningArtifactId** (*string*) -- **[REQUIRED]** The identifier of the provisioning artifact. For example, "pa-4abcdjnxjj6ne". * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServiceActionSummaries': [ { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'DefinitionType': 'SSM_AUTOMATION' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ServiceActionSummaries** *(list) --* An object containing information about the self-service actions associated with the provisioning artifact. * *(dict) --* Detailed information about the self-service action. * **Id** *(string) --* The self-service action identifier. * **Name** *(string) --* The self-service action name. * **Description** *(string) --* The self-service action description. * **DefinitionType** *(string) --* The self-service action definition type. For example, "SSM_AUTOMATION". * **NextToken** *(string) --* A token to resume pagination. ServiceCatalog / Paginator / ListPrincipalsForPortfolio ListPrincipalsForPortfolio ************************** class ServiceCatalog.Paginator.ListPrincipalsForPortfolio paginator = client.get_paginator('list_principals_for_portfolio') paginate(**kwargs) Creates an iterator that will paginate through responses from "ServiceCatalog.Client.list_principals_for_portfolio()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AcceptLanguage='string', PortfolioId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AcceptLanguage** (*string*) -- The language code. * "jp" - Japanese * "zh" - Chinese * **PortfolioId** (*string*) -- **[REQUIRED]** The portfolio identifier. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Principals': [ { 'PrincipalARN': 'string', 'PrincipalType': 'IAM'|'IAM_PATTERN' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Principals** *(list) --* The >>``<>``<>``<<^https?:/// >>``<>``<>``<>``<>``<>*<>ResourceName_<>*<>``<>ResourceName_<