Continuum / Client / get_environment

get_environment¶

Continuum.Client.get_environment(**kwargs)¶

Retrieves the current state and configuration of an environment.

Request Syntax

response = client.get_environment(
    environmentId='string'
)

Parameters:

environmentId (string) –

[REQUIRED]

The unique identifier of the environment to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string',
    'environmentArn': 'string',
    'name': 'string',
    'status': 'ACTIVE',
    'statusMessage': 'string',
    'statusUpdatedAt': datetime(2015, 1, 1),
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'configuration': {
        'codeConfiguration': {
            'collectorDetails': {
                'collectorDataAccessRoleArn': 'string'
            },
            'sourceConfiguration': {
                's3Sources': [
                    {
                        'integrationId': 'string',
                        'codePrefix': 'string',
                        'contextPrefix': 'string'
                    },
                ],
                'repositorySources': [
                    {
                        'integrationId': 'string',
                        'repository': 'string',
                        'defaultBranch': 'string'
                    },
                ]
            },
            'environmentConfiguration': {
                'network': {
                    'allowedDomains': [
                        'string',
                    ]
                },
                'scanFrequency': 'string',
                'patchCreationPolicy': 'ENABLED'|'DISABLED'
            },
            'latestScan': {
                'scanRunId': 'string',
                'status': 'SUBMITTED'|'WAITING_FOR_BUILD'|'BUILDING'|'WAITING_FOR_SCAN'|'SCANNING'|'SUCCEEDED'|'FAILED',
                'origin': 'MANUAL'|'SCHEDULED',
                'createdAt': datetime(2015, 1, 1),
                'completedAt': datetime(2015, 1, 1),
                'failureMessage': 'string',
                'failureStage': 'SUBMITTED'|'WAITING_FOR_BUILD'|'BUILDING'|'WAITING_FOR_SCAN'|'SCANNING'
            }
        }
    }
}

Response Structure

(dict) –

Contains the current state and configuration of the requested environment.
- environmentId (string) –
  
  The unique identifier of the environment.
- environmentArn (string) –
  
  The ARN of the environment.
- name (string) –
  
  The customer-visible name of the environment.
- status (string) –
  
  The current operational status of the environment.
- statusMessage (string) –
  
  Human-readable details about the current status. Present when the status requires additional context (e.g., failure reason).
- statusUpdatedAt (datetime) –
  
  The timestamp when the status last transitioned.
- createdAt (datetime) –
  
  The timestamp when the environment was created.
- updatedAt (datetime) –
  
  The timestamp when the environment’s properties were last updated.
- configuration (dict) –
  
  Type-specific configuration and state, including code sources, operating policy, Collector details, and the latest scan.
  - codeConfiguration (dict) –
    
    Configuration and scan state for a code-scanning environment.
    - collectorDetails (dict) –
      
      Collector data access configuration. Omitted when no Collector data access role is configured.
      - collectorDataAccessRoleArn (string) –
        
        IAM role that Continuum assumes to authorize its access to associated Collector inventory. Required for nonempty Collector inventory resolution, in the same account or across accounts. This is independent from any S3 source role.
    - sourceConfiguration (dict) –
      
      Sources in the shape accepted by CreateEnvironment and UpdateEnvironment.
      - s3Sources (list) –
        
        S3 sources backed by previously-created S3 integrations.
        
        (dict) –
        
        An S3 source for one environment, backed by a previously-created S3 integration.
        
        integrationId (string) –
        
        Identifier of an S3 integration in the caller’s account. The integration supplies the bucket, the read role, and the external ID Continuum uses to read the prefixes.
        
        codePrefix (string) –
        
        Prefix containing source code. Defaults to code/ when omitted.
        
        contextPrefix (string) –
        
        Prefix containing customer-authored context. Defaults to context/ when omitted.
      - repositorySources (list) –
        
        Explicit repository selections from previously-created integrations.
        
        (dict) –
        
        One repository selected from a previously-created integration.
        
        integrationId (string) –
        
        Integration that provides the selected repository.
        
        repository (string) –
        
        Repository selected from that integration in owner/repository form.
        
        defaultBranch (string) –
        
        Branch used when a scan does not choose a more specific revision.
    - environmentConfiguration (dict) –
      
      Operating policy in the shape accepted by CreateEnvironment and UpdateEnvironment.
      - network (dict) –
        
        Network policy for agent execution.
        
        allowedDomains (list) –
        
        Domains that an environment’s agent execution may contact.
        
        (string) –
        
        A domain name permitted for build-time dependency resolution.
      - scanFrequency (string) –
        
        Recurring scan interval: P1D (1 day), P2D (2 days), or P7D (7 days). PT0H disables recurring scans. Defaults to P1D when creating an environment.
      - patchCreationPolicy (string) –
        
        Whether Continuum creates a patch for a proposed remediation. Defaults to DISABLED.
    - latestScan (dict) –
      
      The newest scan requested for this environment, if one exists.
      - scanRunId (string) –
        
        The unique scan identifier.
      - status (string) –
        
        Current customer-visible status.
      - origin (string) –
        
        Why the scan was created. Always present.
      - createdAt (datetime) –
        
        Time at which Continuum accepted the scan request.
      - completedAt (datetime) –
        
        Time at which a terminal result was recorded.
      - failureMessage (string) –
        
        Failure detail present for unsuccessful scans.
      - failureStage (string) –
        
        Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.

get_environment¶

Request Syntax

Response Syntax

Response Structure

Exceptions