Skip to content

get_repository_sync_status

get_repository_sync_status(
    branch: BranchName,
    repository_link_id: RepositoryLinkId,
    sync_type: SyncConfigurationType,
    *,
    config_overrides: Optional[CodeConnectionsClientConfig] = None,
) -> GetRepositorySyncStatusOutput

Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.

Parameters:

  • branch (BranchName) –

    The branch of the repository link for the requested repository sync status.

  • repository_link_id (RepositoryLinkId) –

    The repository link ID for the requested repository sync status.

  • sync_type (SyncConfigurationType) –

    The sync type of the requested sync status.

Raises:

Source code in docs_src/capo_codeconnections/_services/code_connections.py
def get_repository_sync_status(
    self,
    branch: "capo_codeconnections.types.branch_name.BranchName",
    repository_link_id: "capo_codeconnections.types.repository_link_id.RepositoryLinkId",
    sync_type: "capo_codeconnections.types.sync_configuration_type.SyncConfigurationType",
    *,
    config_overrides: Optional[CodeConnectionsClientConfig] = None,
) -> "capo_codeconnections.types.get_repository_sync_status_output.GetRepositorySyncStatusOutput":
    """<p>Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.</p>

    Args:
        branch: <p>The branch of the repository link for the requested repository sync status.</p>
        repository_link_id: <p>The repository link ID for the requested repository sync status.</p>
        sync_type: <p>The sync type of the requested sync status.</p>

    Raises:
        capo_codeconnections.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_codeconnections.errors.internal_server_exception.InternalServerException: <p>Received an internal server exception. Try again later.</p>
        capo_codeconnections.errors.invalid_input_exception.InvalidInputException: <p>The input is not valid. Verify that the action is typed correctly.</p>
        capo_codeconnections.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found. Verify the connection resource ARN and try again.</p>
        capo_codeconnections.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codeconnections.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codeconnections.types.get_repository_sync_status_input.GetRepositorySyncStatusInput]",
    ) -> OperationResponse[
        "capo_codeconnections.types.get_repository_sync_status_output.GetRepositorySyncStatusOutput"
    ]:
        import capo_codeconnections._operations.code_connections_20231201.get_repository_sync_status

        output, http_response = (
            capo_codeconnections._operations.code_connections_20231201.get_repository_sync_status.get_repository_sync_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRepositorySyncStatus")
    )
    input_: capo_codeconnections.types.get_repository_sync_status_input.GetRepositorySyncStatusInput = {
        "branch": branch,
        "repository_link_id": repository_link_id,
        "sync_type": sync_type,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output