describe_project

describe_project(**kwargs)

Describes the details of a project.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    ProjectName='string'
)
Parameters
ProjectName (string) --

[REQUIRED]

The name of the project to describe.

Return type
dict
Returns
Response Syntax
{
    'ProjectArn': 'string',
    'ProjectName': 'string',
    'ProjectId': 'string',
    'ProjectDescription': 'string',
    'ServiceCatalogProvisioningDetails': {
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string',
        'PathId': 'string',
        'ProvisioningParameters': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'ServiceCatalogProvisionedProductDetails': {
        'ProvisionedProductId': 'string',
        'ProvisionedProductStatusMessage': 'string'
    },
    'ProjectStatus': 'Pending'|'CreateInProgress'|'CreateCompleted'|'CreateFailed'|'DeleteInProgress'|'DeleteFailed'|'DeleteCompleted'|'UpdateInProgress'|'UpdateCompleted'|'UpdateFailed',
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.

    • ProjectName (string) --

      The name of the project.

    • ProjectId (string) --

      The ID of the project.

    • ProjectDescription (string) --

      The description of the project.

    • ServiceCatalogProvisioningDetails (dict) --

      Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

      • ProductId (string) --

        The ID of the product to provision.

      • ProvisioningArtifactId (string) --

        The ID of the provisioning artifact.

      • PathId (string) --

        The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

      • ProvisioningParameters (list) --

        A list of key value pairs that you specify when you provision a product.

        • (dict) --

          A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

          • Key (string) --

            The key that identifies a provisioning parameter.

          • Value (string) --

            The value of the provisioning parameter.

    • ServiceCatalogProvisionedProductDetails (dict) --

      Information about a provisioned service catalog product.

      • ProvisionedProductId (string) --

        The ID of the provisioned product.

      • ProvisionedProductStatusMessage (string) --

        The current status of the 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.
    • ProjectStatus (string) --

      The status of the project.

    • CreatedBy (dict) --

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

      • IamIdentity (dict) --

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) --

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) --

          The person or application which assumes the IAM identity.

    • CreationTime (datetime) --

      The time when the project was created.

    • LastModifiedTime (datetime) --

      The timestamp when project was last modified.

    • LastModifiedBy (dict) --

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

      • IamIdentity (dict) --

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) --

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) --

          The person or application which assumes the IAM identity.