Amazon CodeCatalyst

2023/03/01 - Amazon CodeCatalyst - 1 new1 updated api methods

Changes  Published Dev Environments StopDevEnvironmentSession API

StopDevEnvironmentSession (new) Link ¶

Stops a session for a specified Dev Environment.

See also: AWS API Documentation

Request Syntax

client.stop_dev_environment_session(
    spaceName='string',
    projectName='string',
    id='string',
    sessionId='string'
)
type spaceName:

string

param spaceName:

[REQUIRED]

The name of the space.

type projectName:

string

param projectName:

[REQUIRED]

The name of the project in the space.

type id:

string

param id:

[REQUIRED]

The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.

type sessionId:

string

param sessionId:

[REQUIRED]

The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.

rtype:

dict

returns:

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'sessionId': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

    • sessionId (string) --

      The system-generated unique ID of the Dev Environment session.

CreateAccessToken (updated) Link ¶
Changes (response)
{'accessTokenId': 'string'}

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications like Git and integrated development environments (IDEs). For more information, see Managing personal access tokens in Amazon CodeCatalyst.

See also: AWS API Documentation

Request Syntax

client.create_access_token(
    name='string',
    expiresTime=datetime(2015, 1, 1)
)
type name:

string

param name:

[REQUIRED]

The friendly name of the personal access token.

type expiresTime:

datetime

param expiresTime:

The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

rtype:

dict

returns:

Response Syntax

{
    'secret': 'string',
    'name': 'string',
    'expiresTime': datetime(2015, 1, 1),
    'accessTokenId': 'string'
}

Response Structure

  • (dict) --

    • secret (string) --

      The secret value of the personal access token.

    • name (string) --

      The friendly name of the personal access token.

    • expiresTime (datetime) --

      The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.

    • accessTokenId (string) --

      The system-generated unique ID of the access token.