AWS API Changes

2021/05/27 - AWS Device Farm - 4 updated api methods

Changes Introduces support for using our desktop testing service with applications hosted within your Virtual Private Cloud (VPC).

CreateTestGridProject (updated)

Link ¶
Changes (request, response)
Request

{'vpcConfig': {'securityGroupIds': ['string'],
               'subnetIds': ['string'],
               'vpcId': 'string'}}

Response

{'testGridProject': {'vpcConfig': {'securityGroupIds': ['string'],
                                   'subnetIds': ['string'],
                                   'vpcId': 'string'}}}

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

See also: AWS API Documentation

Request Syntax

client.create_test_grid_project(
    name='string',
    description='string',
    vpcConfig={
        'securityGroupIds': [
            'string',
        ],
        'subnetIds': [
            'string',
        ],
        'vpcId': 'string'
    }
)

type name

string

param name

[REQUIRED]

Human-readable name of the Selenium testing project.

type description

string

param description

Human-readable description of the project.

type vpcConfig

dict

param vpcConfig

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

securityGroupIds (list) -- [REQUIRED]

A list of VPC security group IDs in your Amazon VPC.
- (string) --
subnetIds (list) -- [REQUIRED]

A list of VPC subnet IDs in your Amazon VPC.
- (string) --
vpcId (string) -- [REQUIRED]

The ID of the Amazon VPC.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- testGridProject (dict) --
  
  ARN of the Selenium testing project that was created.
  - arn (string) --
    
    The ARN for the project.
  - name (string) --
    
    A human-readable name for the project.
  - description (string) --
    
    A human-readable description for the project.
  - vpcConfig (dict) --
    
    The VPC security groups and subnets that are attached to a project.
    - securityGroupIds (list) --
      
      A list of VPC security group IDs in your Amazon VPC.
      - (string) --
    - subnetIds (list) --
      
      A list of VPC subnet IDs in your Amazon VPC.
      - (string) --
    - vpcId (string) --
      
      The ID of the Amazon VPC.
  - created (datetime) --
    
    When the project was created.

GetTestGridProject (updated)

Link ¶
Changes (response)

{'testGridProject': {'vpcConfig': {'securityGroupIds': ['string'],
                                   'subnetIds': ['string'],
                                   'vpcId': 'string'}}}

Retrieves information about a Selenium testing project.

See also: AWS API Documentation

Request Syntax

client.get_test_grid_project(
    projectArn='string'
)

type projectArn

string

param projectArn

[REQUIRED]

The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- testGridProject (dict) --
  
  A TestGridProject.
  - arn (string) --
    
    The ARN for the project.
  - name (string) --
    
    A human-readable name for the project.
  - description (string) --
    
    A human-readable description for the project.
  - vpcConfig (dict) --
    
    The VPC security groups and subnets that are attached to a project.
    - securityGroupIds (list) --
      
      A list of VPC security group IDs in your Amazon VPC.
      - (string) --
    - subnetIds (list) --
      
      A list of VPC subnet IDs in your Amazon VPC.
      - (string) --
    - vpcId (string) --
      
      The ID of the Amazon VPC.
  - created (datetime) --
    
    When the project was created.

ListTestGridProjects (updated)

Link ¶
Changes (response)

{'testGridProjects': {'vpcConfig': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string'],
                                    'vpcId': 'string'}}}

Gets a list of all Selenium testing projects in your account.

See also: AWS API Documentation

Request Syntax

client.list_test_grid_projects(
    maxResult=123,
    nextToken='string'
)

type maxResult

integer

param maxResult

Return no more than this number of results.

type nextToken

string

param nextToken

From a response, used to continue a paginated listing.

rtype

dict

returns

Response Syntax

{
    'testGridProjects': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'vpcConfig': {
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ],
                'vpcId': 'string'
            },
            'created': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- testGridProjects (list) --
  
  The list of TestGridProjects, based on a ListTestGridProjectsRequest.
  - (dict) --
    
    A Selenium testing project. Projects are used to collect and collate sessions.
    - arn (string) --
      
      The ARN for the project.
    - name (string) --
      
      A human-readable name for the project.
    - description (string) --
      
      A human-readable description for the project.
    - vpcConfig (dict) --
      
      The VPC security groups and subnets that are attached to a project.
      - securityGroupIds (list) --
        
        A list of VPC security group IDs in your Amazon VPC.
        
        (string) --
      - subnetIds (list) --
        
        A list of VPC subnet IDs in your Amazon VPC.
        
        (string) --
      - vpcId (string) --
        
        The ID of the Amazon VPC.
    - created (datetime) --
      
      When the project was created.
- nextToken (string) --
  
  Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.

UpdateTestGridProject (updated)

Link ¶
Changes (request, response)
Request

{'vpcConfig': {'securityGroupIds': ['string'],
               'subnetIds': ['string'],
               'vpcId': 'string'}}

Response

{'testGridProject': {'vpcConfig': {'securityGroupIds': ['string'],
                                   'subnetIds': ['string'],
                                   'vpcId': 'string'}}}

Change details of a project.

See also: AWS API Documentation

Request Syntax

client.update_test_grid_project(
    projectArn='string',
    name='string',
    description='string',
    vpcConfig={
        'securityGroupIds': [
            'string',
        ],
        'subnetIds': [
            'string',
        ],
        'vpcId': 'string'
    }
)

type projectArn

string

param projectArn

[REQUIRED]

ARN of the project to update.

type name

string

param name

Human-readable name for the project.

type description

string

param description

Human-readable description for the project.

type vpcConfig

dict

param vpcConfig

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

securityGroupIds (list) -- [REQUIRED]

A list of VPC security group IDs in your Amazon VPC.
- (string) --
subnetIds (list) -- [REQUIRED]

A list of VPC subnet IDs in your Amazon VPC.
- (string) --
vpcId (string) -- [REQUIRED]

The ID of the Amazon VPC.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- testGridProject (dict) --
  
  The project, including updated information.
  - arn (string) --
    
    The ARN for the project.
  - name (string) --
    
    A human-readable name for the project.
  - description (string) --
    
    A human-readable description for the project.
  - vpcConfig (dict) --
    
    The VPC security groups and subnets that are attached to a project.
    - securityGroupIds (list) --
      
      A list of VPC security group IDs in your Amazon VPC.
      - (string) --
    - subnetIds (list) --
      
      A list of VPC subnet IDs in your Amazon VPC.
      - (string) --
    - vpcId (string) --
      
      The ID of the Amazon VPC.
  - created (datetime) --
    
    When the project was created.