Continuum / Client / get_code_issue

get_code_issue

Continuum.Client.get_code_issue(**kwargs)

Retrieves the current state and details of an issue.

See also: AWS API Documentation

Request Syntax

response = client.get_code_issue(
    environmentId='string',
    issueId='string'
)

Parameters:

• environmentId (string) –

  [REQUIRED]

  The environment that owns the issue.

• issueId (string) –

  [REQUIRED]

  The unique identifier of the issue to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'issueId': 'string',
    'issueArn': 'string',
    'name': 'string',
    'synopsis': 'string',
    'severity': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
    'confidence': 123,
    'severityReasoning': 'string',
    'summary': 'string',
    'findingIds': [
        'string',
    ],
    'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'phase': 'VALIDATION'|'PRIORITIZATION'|'REMEDIATION',
    'statusReason': 'INTERNAL_ERROR'|'REMEDIATION_FAILED',
    'statusMessage': 'string',
    'statusUpdatedAt': datetime(2015, 1, 1),
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'evidenceAvailability': 'NONE'|'AVAILABLE',
    'patchDelivery': {
        'status': 'PENDING'|'SUCCEEDED'|'FAILED'|'SKIPPED',
        'patchCount': 123,
        'succeededCount': 123,
        'failedCount': 123,
        'failureReasons': [
            'ARTIFACT_READ_FAILED'|'ARTIFACT_SOURCE_MISMATCH'|'ARTIFACT_SOURCE_MISSING'|'BUILD_NOT_FOUND'|'BUILD_READ_FAILED'|'BUILD_RESULT_SCOPE_MISMATCH'|'DELIVERY_NOT_CONFIGURED'|'DELIVERY_SOURCE_KIND_CHANGED'|'DUPLICATE_LOGICAL_REPOSITORY'|'DUPLICATE_OR_INVALID_REPOSITORY'|'ENVIRONMENT_DELETED'|'ENVIRONMENT_NOT_ACTIVE'|'ENVIRONMENT_NOT_FOUND'|'ENVIRONMENT_READ_FAILED'|'S3_ACCESS_DENIED'|'S3_SOURCE_PREFIX_OVERLAP'|'SOURCE_INTEGRATION_UNRESOLVED'|'SOURCE_INTEGRATION_READ_FAILED'|'SOURCE_INTEGRATION_INVALID'|'SOURCE_INTEGRATION_CHANGED'|'EXPORT_CREDENTIALS_MISSING'|'EXPORT_CREDENTIAL_EXPIRY_INVALID'|'EXPORT_DESTINATION_INVALID'|'EXPORT_EXISTING_OBJECT_MISMATCH'|'EXPORT_PUT_FAILED'|'EXPORT_RECONCILIATION_READ_FAILED'|'EXPORT_ROLE_ASSUMPTION_FAILED'|'GITHUB_ACCESS_DENIED'|'GITHUB_BASE_NOT_FOUND'|'GITHUB_BRANCH_CONFLICT'|'GITHUB_NOT_FOUND'|'GITHUB_RATE_LIMITED'|'GITHUB_REPOSITORY_CHANGED'|'GITHUB_REPOSITORY_NOT_FOUND'|'GITHUB_REQUEST_FAILED'|'GITHUB_REQUEST_REJECTED'|'GITHUB_RESPONSE_INVALID'|'GREEN_ATTEMPT_NOT_SUCCESSFUL'|'GREEN_COMPLETION_NOT_OBSERVED'|'PATCH_NOT_SELECTED'|'INCOMPLETE_SOURCE_REFERENCE'|'INVALID_ARCHIVE_DIGEST'|'INVALID_ARTIFACT_SOURCE'|'INVALID_COMPLETED_MANIFEST'|'INVALID_EXPORT_RECEIPT'|'INVALID_GITHUB_PROVENANCE'|'INVALID_S3_DESTINATION'|'INVALID_SERVICE_RECEIPT'|'INVALID_SOURCE_INVENTORY'|'INVALID_SOURCE_MANIFEST'|'INVALID_SOURCE_REFERENCE'|'ISSUE_INTEGRITY_FAILURE'|'ISSUE_NOT_FOUND'|'MANIFEST_INVENTORY_MISMATCH'|'MANIFEST_PROVENANCE_CHANGED'|'MANIFEST_REPOSITORY_SET_MISMATCH'|'MANIFEST_SCOPE_OR_VERSION_MISMATCH'|'MISSING_BUILD_RESULT'|'MISSING_COMPLETED_MANIFEST'|'MISSING_RESULT_DIGEST'|'MISSING_SOURCE_MANIFEST'|'MISSING_SOURCE_TARGET'|'PATCH_NOT_APPLICABLE'|'PATCH_STORAGE_IDENTITY_MISSING'|'PATCH_UNSUPPORTED'|'PUBLICATION_OUTCOME_UNKNOWN_AFTER_RETRY_LIMIT'|'PUBLISHER_DEADLINE_EXCEEDED'|'RESULT_COMPLETED_MANIFEST_MISMATCH'|'RESULT_SOURCE_BINDING_MISMATCH'|'SERVICE_COPY_DIGEST_MISMATCH'|'SERVICE_OBJECT_READ_FAILED'|'SERVICE_OBJECT_TOO_LARGE'|'SERVICE_RECEIPT_OUTSIDE_ISSUE'|'SOURCE_OBJECT_DIGEST_MISMATCH'|'SOURCE_REFERENCE_OUTSIDE_BUILD'|'SOURCE_TARGET_BUILD_MISMATCH'|'UNKNOWN_REPOSITORY'|'UNKNOWN_SOURCE_PROVIDER'|'UNSUPPORTED_ENVIRONMENT_SCHEMA'|'github_destination_not_enabled'|'patch_creation_policy_disabled',
        ]
    }
}

Response Structure

• (dict) –

  Contains the current state and details of the requested issue.

  • issueId (string) –

    The unique identifier of the issue.

  • issueArn (string) –

    The ARN of the issue.

  • name (string) –

    The name of the issue.

  • synopsis (string) –

    A free-form synopsis of the issue.

  • severity (string) –

    Current severity: the FindingSeverity seed at create, overwritten by the authoritative severity that prioritization assigns after validation.

  • confidence (integer) –

    The likelihood that this issue is a true positive, expressed as a percentage (0-100).

  • severityReasoning (string) –

    The justification for the current severity. Always leads with a customer-facing basis clause synthesized from how the severity was determined (e.g. “Severity from finding.”, “Severity from Continuum system.”); when prioritization has run, its own reasoning follows. Issues created before the basis clause was introduced return their original reasoning without it.

  • summary (string) –

    The remediation completion summary, when the green stage has run.

  • findingIds (list) –

    The findings that motivated this issue. Bare identifiers only – a caller authorized for GetCodeIssue is not necessarily authorized to read finding detail; call GetCodeFinding for that. Every referenced finding is included regardless of origin (both CustomerUploaded and ContinuumScanner).

    • (string) –

      The unique identifier for a Finding resource.

  • status (string) –

    The current lifecycle status of the issue.

  • phase (string) –

    The part of the workflow the issue is in. Present when status is IN_PROGRESS, and when status is FAILED and the failing phase is known.

  • statusReason (string) –

    Why the issue failed. Present only when status is FAILED.

  • statusMessage (string) –

    Customer-facing explanation of statusReason. Present only when status is FAILED.

  • statusUpdatedAt (datetime) –

    The timestamp when the status or phase last changed.

  • createdAt (datetime) –

    The timestamp when the issue was created.

  • updatedAt (datetime) –

    The timestamp when any field of the issue last changed. Advances on every mutation (including score-only updates that do not transition status), so it is greater than or equal to statusUpdatedAt.

  • evidenceAvailability (string) –

    Whether the issue has any attached evidence (formerly ‘artifacts’: tool output, remediation proposals, patches). NONE = no evidence; AVAILABLE = at least one evidence item exists. Computed at read time.

  • patchDelivery (dict) –

    Customer delivery of the issue’s patches, summarized from its PATCH artifacts at read time. Absent when no patch has a destination delivery.

    • status (string) –

      The overall result, in priority order: FAILED when any patch’s destination delivery failed or exhausted its retries; otherwise PENDING while any is still in progress; otherwise SUCCEEDED when at least one was delivered; otherwise SKIPPED.

    • patchCount (integer) –

      Number of the issue’s patches that have a destination delivery.

    • succeededCount (integer) –

      Number of those patches delivered to their destination.

    • failedCount (integer) –

      Number of those patches whose delivery failed or exhausted its retries.

    • failureReasons (list) –

      Distinct reasons of the failed deliveries, in ascending order. Present only when failedCount is greater than zero.

      • (string) –

        Cause of a PATCH delivery’s current state; used only by DeliveryState.reason. These are outcomes of one delivery lifecycle, not shared operation error enums. The two existing skip-code wire values are retained for compatibility.

Exceptions

• Continuum.Client.exceptions.ValidationException

• Continuum.Client.exceptions.InternalServerException

• Continuum.Client.exceptions.ResourceNotFoundException

• Continuum.Client.exceptions.ThrottlingException

• Continuum.Client.exceptions.AccessDeniedException