ServiceCatalog / Client / search_products_as_admin

search_products_as_admin#

ServiceCatalog.Client.search_products_as_admin(**kwargs)#

Gets information about the products for the specified portfolio or all products.

See also: AWS API Documentation

Request Syntax

response = client.search_products_as_admin(
    AcceptLanguage='string',
    PortfolioId='string',
    Filters={
        'string': [
            'string',
        ]
    },
    SortBy='Title'|'VersionCount'|'CreationDate',
    SortOrder='ASCENDING'|'DESCENDING',
    PageToken='string',
    PageSize=123,
    ProductSource='ACCOUNT'
)
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.

  • PageToken (string) – The page token for the next set of results. To retrieve the first set of results, use null.

  • PageSize (integer) – The maximum number of items to return with this call.

  • ProductSource (string) – Access level of the source of the product.

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'
                }
            }
        },
    ],
    'NextPageToken': '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.

    • NextPageToken (string) –

      The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Exceptions