DeviceFarm / Client / create_project

create_project#

DeviceFarm.Client.create_project(**kwargs)#

Creates a project.

See also: AWS API Documentation

Request Syntax

response = client.create_project(
    name='string',
    defaultJobTimeoutMinutes=123,
    vpcConfig={
        'securityGroupIds': [
            'string',
        ],
        'subnetIds': [
            'string',
        ],
        'vpcId': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The project’s name.

  • defaultJobTimeoutMinutes (integer) – Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.

  • vpcConfig (dict) –

    The VPC security groups and subnets that are attached to a project.

    • securityGroupIds (list) – [REQUIRED]

      An array of one or more security groups IDs in your Amazon VPC.

      • (string) –

    • subnetIds (list) – [REQUIRED]

      An array of one or more subnet IDs in your Amazon VPC.

      • (string) –

    • vpcId (string) – [REQUIRED]

      The ID of the Amazon VPC.

Return type:

dict

Returns:

Response Syntax

{
    'project': {
        'arn': 'string',
        'name': 'string',
        'defaultJobTimeoutMinutes': 123,
        'created': datetime(2015, 1, 1),
        'vpcConfig': {
            'securityGroupIds': [
                'string',
            ],
            'subnetIds': [
                'string',
            ],
            'vpcId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    Represents the result of a create project request.

    • project (dict) –

      The newly created project.

      • arn (string) –

        The project’s ARN.

      • name (string) –

        The project’s name.

      • defaultJobTimeoutMinutes (integer) –

        The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.

      • created (datetime) –

        When the project was created.

      • vpcConfig (dict) –

        The VPC security groups and subnets that are attached to a project.

        • securityGroupIds (list) –

          An array of one or more security groups IDs in your Amazon VPC.

          • (string) –

        • subnetIds (list) –

          An array of one or more subnet IDs in your Amazon VPC.

          • (string) –

        • vpcId (string) –

          The ID of the Amazon VPC.

Exceptions

Examples

The following example creates a new project named MyProject.

response = client.create_project(
    # A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices.
    name='MyProject',
)

print(response)

Expected Output:

{
    'project': {
        'name': 'MyProject',
        'arn': 'arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE',
        'created': datetime(2016, 8, 31, 16, 28, 59, 2, 244, 0),
    },
    'ResponseMetadata': {
        '...': '...',
    },
}